com.fasterxml.jackson.databind.jsonSchema.types
Class ArraySchema

java.lang.Object
  com.fasterxml.jackson.databind.jsonSchema.types.JsonSchema
      com.fasterxml.jackson.databind.jsonSchema.types.SimpleTypeSchema
          com.fasterxml.jackson.databind.jsonSchema.types.ContainerTypeSchema
              com.fasterxml.jackson.databind.jsonSchema.types.ArraySchema

public class ArraySchema
extends ContainerTypeSchema

Nested Class Summary

static class	ArraySchema.AdditionalItems This provides a definition for additional items in an array instance when tuple definitions of the items is provided.
static class	ArraySchema.ArrayItems When this attribute value is an array of jsonSchemas and the instance value is an array, each position in the instance array MUST conform to the jsonSchema in the corresponding position for this array.
static class	ArraySchema.Items This attribute defines the allowed items in an instance array, and MUST be a jsonSchema or an array of jsonSchemas.
static class	ArraySchema.NoAdditionalItems This can be false to indicate additional items in the array are not allowed
static class	ArraySchema.SchemaAdditionalItems or it can be a jsonSchema that defines the jsonSchema of the additional items.
static class	ArraySchema.SingleItems When this attribute value is a jsonSchema and the instance value is an array, then all the items in the array MUST be valid according to the jsonSchema.

Nested classes/interfaces inherited from class com.fasterxml.jackson.databind.jsonSchema.types.JsonSchema

JsonSchema.JsonSchemaIdResolver

Constructor Summary

ArraySchema()

Method Summary

ArraySchema	asArraySchema() Attempt to return this JsonSchema as an ArraySchema
boolean	equals(Object obj)
ArraySchema.AdditionalItems	getAdditionalItems() additionalItems
ArraySchema.Items	getItems() items
Integer	getMaxItems() maxItems
Integer	getMinItems() minItems
com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatTypes	getType()
Boolean	getUniqueItems() uniqueItems
boolean	isArraySchema() determine if this JsonSchema is an ArraySchema.
void	setAdditionalItems(ArraySchema.AdditionalItems additionalItems) additionalItems
void	setItems(ArraySchema.Items items) items
void	setItemsSchema(JsonSchema jsonSchema) Convenience method to set the json schema for the items field
void	setMaxItems(Integer maxItems) maxItems
void	setMinItems(Integer minItems) minItems
void	setUniqueItems(Boolean uniqueItems) uniqueItems

Methods inherited from class com.fasterxml.jackson.databind.jsonSchema.types.ContainerTypeSchema

asContainerSchema, getEnums, isContainerTypeSchema, setEnums

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

asSimpleTypeSchema, getDefault, getDescription, getTitle, isSimpleTypeSchema, setDefault, setDescription, setTitle

Methods inherited from class com.fasterxml.jackson.databind.jsonSchema.types.JsonSchema

asAnySchema, asBooleanSchema, asIntegerSchema, asNullSchema, asNumberSchema, asObjectSchema, asStringSchema, asUnionTypeSchema, asValueSchemaSchema, get$ref, get$schema, getDisallow, getExtends, getId, getRequired, isAnySchema, isBooleanSchema, isIntegerSchema, isNullSchema, isNumberSchema, isObjectSchema, isStringSchema, isUnionTypeSchema, isValueTypeSchema, minimalForFormat, set$ref, set$schema, setDisallow, setExtends, setId, setRequired

Methods inherited from class java.lang.Object

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

Constructor Detail

ArraySchema

public ArraySchema()

Method Detail

asArraySchema

public ArraySchema asArraySchema()

Description copied from class: JsonSchema

Attempt to return this JsonSchema as an ArraySchema

Overrides:

asArraySchema in class JsonSchema

Returns:

this as an ArraySchema if possible, or null otherwise

equals

public boolean equals(Object obj)

Overrides:

equals in class ContainerTypeSchema

getAdditionalItems

public ArraySchema.AdditionalItems getAdditionalItems()

additionalItems

Returns:

the additionalItems

getItems

public ArraySchema.Items getItems()

items

Returns:

the items

getMaxItems

public Integer getMaxItems()

maxItems

Returns:

the maxItems

getMinItems

public Integer getMinItems()

minItems

Returns:

the minItems

getType

public com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatTypes getType()

Specified by:

getType in class JsonSchema

getUniqueItems

public Boolean getUniqueItems()

uniqueItems

Returns:

the uniqueItems

isArraySchema

public boolean isArraySchema()

Description copied from class: JsonSchema

determine if this JsonSchema is an ArraySchema.

Overrides:

isArraySchema in class JsonSchema

Returns:

true if this JsonSchema is an ArraySchema, false otherwise

setAdditionalItems

public void setAdditionalItems(ArraySchema.AdditionalItems additionalItems)

additionalItems

Parameters:

additionalItems - the additionalItems to set

setItems

public void setItems(ArraySchema.Items items)

items

Parameters:

items - the items to set

setItemsSchema

public void setItemsSchema(JsonSchema jsonSchema)

Convenience method to set the json schema for the items field

Parameters:

jsonSchema -

setMaxItems

public void setMaxItems(Integer maxItems)

maxItems

Parameters:

maxItems - the maxItems to set

setMinItems

public void setMinItems(Integer minItems)

minItems

Parameters:

minItems - the minItems to set

setUniqueItems

public void setUniqueItems(Boolean uniqueItems)

uniqueItems

Parameters:

uniqueItems - the uniqueItems to set