com.fasterxml.jackson.module.jsonSchema.types

Class ValueTypeSchema

java.lang.Object

com.fasterxml.jackson.module.jsonSchema.JsonSchema

com.fasterxml.jackson.module.jsonSchema.types.SimpleTypeSchema

com.fasterxml.jackson.module.jsonSchema.types.ValueTypeSchema

Direct Known Subclasses:

BooleanSchema, NumberSchema, StringSchema

public abstract class ValueTypeSchema
extends SimpleTypeSchema

This class represents a JsonSchema A primitive type.

Field Summary

Fields

Modifier and Type	Field and Description
protected Set<String>	enums This provides an enumeration of all possible values that are valid for the instance property.
protected com.fasterxml.jackson.databind.jsonFormatVisitors.JsonValueFormat	format This property defines the type of data, content type, or microformat to be expected in the instance property values.

Fields inherited from class com.fasterxml.jackson.module.jsonSchema.types.SimpleTypeSchema

defaultdefault, links, pathStart, title

Constructor Summary

Constructors

Constructor and Description
ValueTypeSchema()

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	_equals(ValueTypeSchema that)
ValueTypeSchema	asValueSchemaSchema() Deprecated. Since 2.7
ValueTypeSchema	asValueTypeSchema() Attempt to return this JsonSchema as a ValueTypeSchema
boolean	equals(Object obj)
Set<String>	getEnums()
com.fasterxml.jackson.databind.jsonFormatVisitors.JsonValueFormat	getFormat()
boolean	isValueTypeSchema() determine if this JsonSchema is an ValueTypeSchema.
void	setEnums(Set<String> enums)
void	setFormat(com.fasterxml.jackson.databind.jsonFormatVisitors.JsonValueFormat format)

Methods inherited from class com.fasterxml.jackson.module.jsonSchema.types.SimpleTypeSchema

_equals, asSimpleTypeSchema, getDefault, getLinks, getPathStart, getTitle, isSimpleTypeSchema, setDefault, setLinks, setPathStart, setTitle

Methods inherited from class com.fasterxml.jackson.module.jsonSchema.JsonSchema

_equals, arraysEqual, asAnySchema, asArraySchema, asBooleanSchema, asContainerSchema, asContainerTypeSchema, asIntegerSchema, asNullSchema, asNumberSchema, asObjectSchema, asStringSchema, asUnionTypeSchema, enrichWithBeanProperty, equals, get$ref, get$schema, getDescription, getDisallow, getExtends, getId, getReadonly, getRequired, getType, isAnySchema, isArraySchema, isBooleanSchema, isContainerTypeSchema, isIntegerSchema, isNullSchema, isNumberSchema, isObjectSchema, isStringSchema, isUnionTypeSchema, minimalForFormat, set$ref, set$schema, setDescription, setDisallow, setExtends, setId, setReadonly, setRequired

Methods inherited from class java.lang.Object

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

Field Detail

enums

protected Set<String> enums

This provides an enumeration of all possible values that are valid for the instance property. This MUST be an array, and each item in the array represents a possible value for the instance value. If this attribute is defined, the instance value MUST be one of the values in the array in order for the schema to be valid. Comparison of enum values uses the same algorithm as defined in "uniqueItems" (Section 5.15).

format

protected com.fasterxml.jackson.databind.jsonFormatVisitors.JsonValueFormat format

This property defines the type of data, content type, or microformat to be expected in the instance property values. A format attribute MAY be one of the values listed below, and if so, SHOULD adhere to the semantics describing for the format. A format SHOULD only be used to give meaning to primitive types (string, integer, number, or boolean). Validators MAY (but are not required to) validate that the instance values conform to a format. Additional custom formats MAY be created. These custom formats MAY be expressed as an URI, and this URI MAY reference a schema of that

NOTE: serialization of `format` was fixed in Jackson 2.7; requires at least this version of databind

Constructor Detail

ValueTypeSchema

public ValueTypeSchema()

Method Detail

asValueSchemaSchema

@Deprecated
public ValueTypeSchema asValueSchemaSchema()

Deprecated. Since 2.7

Overrides:

asValueSchemaSchema in class JsonSchema

asValueTypeSchema

public ValueTypeSchema asValueTypeSchema()

Description copied from class: JsonSchema

Attempt to return this JsonSchema as a ValueTypeSchema

Overrides:

asValueTypeSchema in class JsonSchema

Returns:

this as a ValueTypeSchema if possible, or null otherwise

Since:

2.7

getEnums

public Set<String> getEnums()

getFormat

public com.fasterxml.jackson.databind.jsonFormatVisitors.JsonValueFormat getFormat()

isValueTypeSchema

public boolean isValueTypeSchema()

Description copied from class: JsonSchema

determine if this JsonSchema is an ValueTypeSchema.

Overrides:

isValueTypeSchema in class JsonSchema

Returns:

true if this JsonSchema is an ValueTypeSchema, false otherwise

setEnums

public void setEnums(Set<String> enums)

setFormat

public void setFormat(com.fasterxml.jackson.databind.jsonFormatVisitors.JsonValueFormat format)

equals

public boolean equals(Object obj)

Overrides:

equals in class SimpleTypeSchema

_equals

protected boolean _equals(ValueTypeSchema that)