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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JsonSchema.Definitions Value object to abstract a Map of JSON Schema definitions.
static class	JsonSchema.EnumProperty A JsonSchema.JsonSchemaProperty representing enumerations.
static class	JsonSchema.JsonSchemaProperty A JSON Schema property

Constructor Summary

Constructors

Constructor and Description
JsonSchema(String title, String description, Collection<org.springframework.data.rest.webmvc.json.JsonSchema.AbstractJsonSchemaProperty<?>> properties, JsonSchema.Definitions definitions) Creates a new JsonSchema instance for the given title, description, AbstractJsonSchemaPropertys and JsonSchema.Definitions.

Method Summary

Modifier and Type	Method and Description
org.springframework.data.rest.webmvc.json.JsonSchema.PropertiesContainer	getContainer()
JsonSchema.Definitions	getDefinitions()
String	getDescription()
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.AbstractJsonSchemaProperty<?>> properties,
                  JsonSchema.Definitions definitions)

Creates a new JsonSchema instance for the given title, description, AbstractJsonSchemaPropertys and JsonSchema.Definitions.

Parameters:

title - must not be null or empty.

description - can be null.

properties - must not be null.

definitions - 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()

getDefinitions

public JsonSchema.Definitions getDefinitions()