Class ArraySchema
java.lang.Object
com.fasterxml.jackson.module.jsonSchema.JsonSchema
com.fasterxml.jackson.module.jsonSchema.types.SimpleTypeSchema
com.fasterxml.jackson.module.jsonSchema.types.ContainerTypeSchema
com.fasterxml.jackson.module.jsonSchema.types.ArraySchema
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
This provides a definition for additional items in an array instance when tuple definitions of the items is provided.static class
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
This attribute defines the allowed items in an instance array, and MUST be a jsonSchema or an array of jsonSchemas.static class
static class
This can be false to indicate additional items in the array are not allowedstatic class
or it can be a jsonSchema that defines the jsonSchema of the additional items.static class
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. -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected ArraySchema.AdditionalItems
protected ArraySchema.Items
protected Integer
This attribute defines the maximum number of values in an arrayprotected Integer
This attribute defines the minimum number of values in an arrayprotected Boolean
This attribute indicates that all items in an array instance MUST be unique (contains no two identical values).Fields inherited from class com.fasterxml.jackson.module.jsonSchema.types.ContainerTypeSchema
enums, oneOf
Fields inherited from class com.fasterxml.jackson.module.jsonSchema.types.SimpleTypeSchema
defaultdefault, links, pathStart, title
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected boolean
_equals
(ArraySchema that) Attempt to return this JsonSchema as anArraySchema
boolean
getItems()
com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatTypes
getType()
boolean
determine if this JsonSchema is anArraySchema
.void
setAdditionalItems
(ArraySchema.AdditionalItems additionalItems) void
setItems
(ArraySchema.Items items) void
setItemsSchema
(JsonSchema jsonSchema) void
setMaxItems
(Integer maxItems) void
setMinItems
(Integer minItems) void
setUniqueItems
(Boolean uniqueItems) Methods inherited from class com.fasterxml.jackson.module.jsonSchema.types.ContainerTypeSchema
_equals, asContainerSchema, asContainerTypeSchema, getEnums, getOneOf, isContainerTypeSchema, setEnums, setOneOf
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, asBooleanSchema, asIntegerSchema, asNullSchema, asNumberSchema, asObjectSchema, asStringSchema, asUnionTypeSchema, asValueSchemaSchema, asValueTypeSchema, enrichWithBeanProperty, equals, get$ref, get$schema, getDescription, getDisallow, getExtends, getId, getReadonly, getRequired, isAnySchema, isBooleanSchema, isIntegerSchema, isNullSchema, isNumberSchema, isObjectSchema, isStringSchema, isUnionTypeSchema, isValueTypeSchema, minimalForFormat, set$ref, set$schema, setDescription, setDisallow, setExtends, setId, setReadonly, setRequired
-
Field Details
-
additionalItems
-
items
-
maxItems
This attribute defines the maximum number of values in an array -
minItems
This attribute defines the minimum number of values in an array -
uniqueItems
This attribute indicates that all items in an array instance MUST be unique (contains no two identical values). Two instance are consider equal if they are both of the same type and: are null; or are booleans/numbers/strings and have the same value; or are arrays, contains the same number of items, and each item in the array is equal to the corresponding item in the other array; or are objects, contains the same property names, and each property in the object is equal to the corresponding property in the other object.
-
-
Constructor Details
-
ArraySchema
public ArraySchema()
-
-
Method Details
-
asArraySchema
Description copied from class:JsonSchema
Attempt to return this JsonSchema as anArraySchema
- Overrides:
asArraySchema
in classJsonSchema
- Returns:
- this as an ArraySchema if possible, or null otherwise
-
getAdditionalItems
-
getItems
-
getMaxItems
-
getMinItems
-
getType
public com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatTypes getType()- Specified by:
getType
in classJsonSchema
-
getUniqueItems
-
isArraySchema
public boolean isArraySchema()Description copied from class:JsonSchema
determine if this JsonSchema is anArraySchema
.- Overrides:
isArraySchema
in classJsonSchema
- Returns:
- true if this JsonSchema is an ArraySchema, false otherwise
-
setAdditionalItems
-
setItems
-
setItemsSchema
-
setMaxItems
-
setMinItems
-
setUniqueItems
-
equals
- Overrides:
equals
in classContainerTypeSchema
-
_equals
-