org.springframework.data.rest.webmvc.json

Class JsonSchema

java.lang.Object

org.springframework.data.rest.webmvc.json.JsonSchema

public class JsonSchema
extends Object

Model class to render JSON schema documents.

Author:

Jon Brisbin, Oliver Gierke

Constructor Summary

Constructors

Constructor and Description
JsonSchema(String title, String description, Collection<org.springframework.data.rest.webmvc.json.JsonSchema.JsonSchemaProperty<?>> properties, org.springframework.data.rest.webmvc.json.JsonSchema.Descriptors descriptors) Creates a new JsonSchema instance for the given title, description, JsonSchemaPropertys and Descriptors.

Method Summary

Modifier and Type	Method and Description
org.springframework.data.rest.webmvc.json.JsonSchema.PropertiesContainer	getContainer()
String	getDescription()
org.springframework.data.rest.webmvc.json.JsonSchema.Descriptors	getDescriptors()
String	getSchema()
String	getTitle()
String	getType()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JsonSchema

public JsonSchema(String title,
                  String description,
                  Collection<org.springframework.data.rest.webmvc.json.JsonSchema.JsonSchemaProperty<?>> properties,
                  org.springframework.data.rest.webmvc.json.JsonSchema.Descriptors descriptors)

Creates a new JsonSchema instance for the given title, description, JsonSchemaPropertys and Descriptors.

Parameters:

title - must not be null or empty.

description - can be null.

properties - must not be null.

descriptors - must not be null.

Method Detail

getSchema

public String getSchema()

getType

public String getType()

getTitle

public String getTitle()

getDescription

public String getDescription()

getContainer

public org.springframework.data.rest.webmvc.json.JsonSchema.PropertiesContainer getContainer()

getDescriptors

public org.springframework.data.rest.webmvc.json.JsonSchema.Descriptors getDescriptors()

Returns:

the descriptors