Package org.springframework.data.rest.webmvc.json

Class JsonSchema.JsonSchemaProperty

java.lang.Object

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

Direct Known Subclasses:

JsonSchema.EnumProperty

Enclosing class:

JsonSchema

public static class JsonSchema.JsonSchemaProperty
extends Object

A JSON Schema property

Since:

2.3

Author:

Oliver Gierke

Field Summary

Fields

Modifier and Type	Field	Description
String	description
JsonSchemaFormat	format
Map<String,String>	items
String	pattern
String	reference
String	type
Boolean	uniqueItems

Method Summary

Modifier and Type	Method	Description
JsonSchema.JsonSchemaProperty	asAssociation()	Turns the current JsonSchema.JsonSchemaProperty into an association.
String	getName()
String	getTitle()
boolean	isReadOnly()
JsonSchema.JsonSchemaProperty	with(TypeInformation<?> type)	Configures the JsonSchema.JsonSchemaProperty to reflect the given type.
JsonSchema.JsonSchemaProperty	withFormat(JsonSchemaFormat format)	Configures the given JsonSchemaFormat to be exposed on the current JsonSchema.JsonSchemaProperty.
JsonSchema.JsonSchemaProperty	withPattern(Pattern pattern)	Configures the JsonSchema.JsonSchemaProperty to require the given Pattern.
protected JsonSchema.JsonSchemaProperty	withReadOnly()
JsonSchema.JsonSchemaProperty	withRegex(String regex)	Configures the JsonSchema.JsonSchemaProperty to require the given regular expression as pattern.
JsonSchema.JsonSchemaProperty	withType(Class<?> type)	Configures the JsonSchema.JsonSchemaProperty to reflect the given type.

Methods inherited from class java.lang.Object

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

Field Details

description

public String description

type

public String type

format

public JsonSchemaFormat format

pattern

public String pattern

uniqueItems

public Boolean uniqueItems

reference

public String reference

items

public Map<String,String> items

Method Details

withType

public JsonSchema.JsonSchemaProperty withType(Class<?> type)

Configures the JsonSchema.JsonSchemaProperty to reflect the given type.

Parameters:

type - must not be null.

Returns:

with

public JsonSchema.JsonSchemaProperty with(TypeInformation<?> type)

Configures the JsonSchema.JsonSchemaProperty to reflect the given type.

Parameters:

type - must not be null.

Returns:

withFormat

public JsonSchema.JsonSchemaProperty withFormat(JsonSchemaFormat format)

Configures the given JsonSchemaFormat to be exposed on the current JsonSchema.JsonSchemaProperty.

Parameters:

format - must not be null.

Returns:

withRegex

public JsonSchema.JsonSchemaProperty withRegex(String regex)

Configures the JsonSchema.JsonSchemaProperty to require the given regular expression as pattern.

Parameters:

regex - must not be null.

Returns:

withPattern

public JsonSchema.JsonSchemaProperty withPattern(Pattern pattern)

Configures the JsonSchema.JsonSchemaProperty to require the given Pattern.

Parameters:

pattern - must not be null.

Returns:

asAssociation

public JsonSchema.JsonSchemaProperty asAssociation()

Turns the current JsonSchema.JsonSchemaProperty into an association.

Returns:

getName

public String getName()

getTitle

public String getTitle()

isReadOnly

public boolean isReadOnly()

withReadOnly

protected JsonSchema.JsonSchemaProperty withReadOnly()