Class ContainerTypeSchema

java.lang.Object

com.fasterxml.jackson.module.jsonSchema.jakarta.JsonSchema

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

com.fasterxml.jackson.module.jsonSchema.jakarta.types.ContainerTypeSchema

Direct Known Subclasses:

ArraySchema, ObjectSchema

public abstract class ContainerTypeSchema
extends SimpleTypeSchema

This class encapsulates the functionality of container type JsonSchema Array and Object

Field Summary

Fields

Modifier and Type	Field	Description
protected Set<String>	enums	This provides an enumeration of all possible values that are valid for the instance property.
protected Set<Object>	oneOf	This provides an enumeration of all possible values that are valid for the instance property.

Fields inherited from class SimpleTypeSchema

defaultdefault, links, pathStart, title

Constructor Summary

Constructors

Constructor	Description
ContainerTypeSchema()

Method Summary

Modifier and Type	Method	Description
protected boolean	_equals(ContainerTypeSchema that)
ContainerTypeSchema	asContainerSchema()	Deprecated. Since 2.7
ContainerTypeSchema	asContainerTypeSchema()	Attempt to return this JsonSchema as a ContainerTypeSchema
boolean	equals(Object obj)
Set<String>	getEnums()
Set<Object>	getOneOf()
boolean	isContainerTypeSchema()	determine if this JsonSchema is an ContainerTypeSchema.
void	setEnums(Set<String> enums)
void	setOneOf(Set<Object> oneOf)

Methods inherited from class SimpleTypeSchema

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

Methods inherited from class JsonSchema

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

Methods inherited from class Object

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

Field Details

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).

oneOf

protected Set<Object> oneOf

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).

Constructor Details

ContainerTypeSchema

public ContainerTypeSchema()

Method Details

asContainerSchema

@Deprecated
public ContainerTypeSchema asContainerSchema()

Deprecated.

Since 2.7

Overrides:

asContainerSchema in class JsonSchema

asContainerTypeSchema

public ContainerTypeSchema asContainerTypeSchema()

Description copied from class: JsonSchema

Attempt to return this JsonSchema as a ContainerTypeSchema

Overrides:

asContainerTypeSchema in class JsonSchema

Returns:

this as an ContainerTypeSchema if possible, or null otherwise

Since:

2.7

getEnums

public Set<String> getEnums()

isContainerTypeSchema

public boolean isContainerTypeSchema()

Description copied from class: JsonSchema

determine if this JsonSchema is an ContainerTypeSchema.

Overrides:

isContainerTypeSchema in class JsonSchema

Returns:

true if this JsonSchema is an ContainerTypeSchema, false otherwise

setEnums

public void setEnums(Set<String> enums)

getOneOf

public Set<Object> getOneOf()

setOneOf

public void setOneOf(Set<Object> oneOf)

equals

public boolean equals(Object obj)

Overrides:

equals in class SimpleTypeSchema

_equals

protected boolean _equals(ContainerTypeSchema that)