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

Class JsonSchema.EnumProperty

java.lang.Object

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

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

Enclosing class:

JsonSchema

public static class JsonSchema.EnumProperty
extends JsonSchema.JsonSchemaProperty

A JsonSchema.JsonSchemaProperty representing enumerations. Will cause all valid values to be rendered in a nested enum property.

Since:

2.3

Author:

Oliver Gierke

Field Summary

Fields inherited from class org.springframework.data.rest.webmvc.json.JsonSchema.JsonSchemaProperty

description, format, items, pattern, reference, type, uniqueItems

Constructor Summary

Constructors

Constructor	Description
EnumProperty(String name, String title, Class<?> type, String description, boolean required)
EnumProperty(String name, String title, List<String> values, String description, boolean required)

Method Summary

Modifier and Type	Method	Description
String	getName()
String	getTitle()
List<String>	getValues()
boolean	isReadOnly()
protected JsonSchema.JsonSchemaProperty	withReadOnly()
JsonSchema.EnumProperty	withValues(List<String> values)	Returns the current JsonSchema.EnumProperty exposing the given values.

Methods inherited from class org.springframework.data.rest.webmvc.json.JsonSchema.JsonSchemaProperty

asAssociation, with, withFormat, withPattern, withRegex, withType

Methods inherited from class java.lang.Object

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

Constructor Details

EnumProperty

public EnumProperty(String name,
 String title,
 Class<?> type,
 String description,
 boolean required)

EnumProperty

public EnumProperty(String name,
 String title,
 List<String> values,
 String description,
 boolean required)

Method Details

getValues

public List<String> getValues()

withValues

public JsonSchema.EnumProperty withValues(List<String> values)

Returns the current JsonSchema.EnumProperty exposing the given values.

Parameters:

values - must not be null.

Returns:

getName

public String getName()

getTitle

public String getTitle()

isReadOnly

public boolean isReadOnly()

withReadOnly

protected JsonSchema.JsonSchemaProperty withReadOnly()