Class ObjectSchema

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

public class ObjectSchema
extends ContainerTypeSchema

This type represents a JsonSchema as an object type

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ObjectSchema.AdditionalProperties
static class	ObjectSchema.Dependency
static class	ObjectSchema.NoAdditionalProperties
static class	ObjectSchema.SchemaAdditionalProperties
static class	ObjectSchema.SchemaDependency	JsonSchema Dependency If the dependency value is a jsonSchema, then the instance object MUST be valid against the jsonSchema.
static class	ObjectSchema.SimpleDependency	Simple Dependency If the dependency value is a string, then the instance object MUST have a property with the same name as the dependency value.

Field Summary

Fields

Modifier and Type	Field	Description
private ObjectSchema.AdditionalProperties	additionalProperties	This attribute defines a jsonSchema for all properties that are not explicitly defined in an object type definition.
private Map<String,Object>	dependencies	This attribute is an object that defines the requirements of a property on an instance object.
private Map<String, JsonSchema>	patternProperties	This attribute is an object that defines the jsonSchema for a set of property names of an object instance.
private Map<String, JsonSchema>	properties	This attribute is an object with property definitions that define the valid values of instance object property values.

Fields inherited from class ContainerTypeSchema

enums, oneOf

Fields inherited from class SimpleTypeSchema

defaultdefault, links, pathStart, title

Constructor Summary

Constructors

Constructor	Description
ObjectSchema()

Method Summary

Modifier and Type	Method	Description
protected boolean	_equals(ObjectSchema that)
boolean	addSchemaDependency(String depender, JsonSchema parentMustMatch)
boolean	addSimpleDependency(String depender, String dependsOn)
ObjectSchema	asObjectSchema()	Attempt to return this JsonSchema as an ObjectSchema
boolean	equals(Object obj)
ObjectSchema.AdditionalProperties	getAdditionalProperties()
Map<String,Object>	getDependencies()
Map<String, JsonSchema>	getPatternProperties()
Map<String, JsonSchema>	getProperties()
com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatTypes	getType()
boolean	isObjectSchema()	determine if this JsonSchema is an ObjectSchema.
void	putOptionalProperty(com.fasterxml.jackson.databind.BeanProperty property, JsonSchema jsonSchema)
void	putOptionalProperty(String name, JsonSchema jsonSchema)
JsonSchema	putPatternProperty(String regex, JsonSchema value)
JsonSchema	putProperty(com.fasterxml.jackson.databind.BeanProperty property, JsonSchema value)
JsonSchema	putProperty(String name, JsonSchema value)
void	rejectAdditionalProperties()
void	setAdditionalProperties(ObjectSchema.AdditionalProperties additionalProperties)
void	setDependencies(Map<String,Object> dependencies)
void	setPatternProperties(Map<String, JsonSchema> patternProperties)
void	setProperties(Map<String, JsonSchema> properties)

Methods inherited from class ContainerTypeSchema

_equals, asContainerSchema, asContainerTypeSchema, getEnums, getOneOf, isContainerTypeSchema, setEnums, setOneOf

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, asStringSchema, asUnionTypeSchema, asValueSchemaSchema, asValueTypeSchema, enrichWithBeanProperty, equals, get$ref, get$schema, getDescription, getDisallow, getExtends, getId, getReadonly, getRequired, isAnySchema, isArraySchema, isBooleanSchema, isIntegerSchema, isNullSchema, isNumberSchema, 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

additionalProperties

private ObjectSchema.AdditionalProperties additionalProperties

This attribute defines a jsonSchema for all properties that are not explicitly defined in an object type definition. If specified, the value MUST be a jsonSchema or a boolean. If false is provided, no additional properties are allowed beyond the properties defined in the jsonSchema. The default value is an empty jsonSchema which allows any value for additional properties.

dependencies

private Map<String,Object> dependencies

This attribute is an object that defines the requirements of a property on an instance object. If an object instance has a property with the same name as a property in this attribute's object, then the instance must be valid against the attribute's property value

patternProperties

private Map<String, JsonSchema> patternProperties

This attribute is an object that defines the jsonSchema for a set of property names of an object instance. The name of each property of this attribute's object is a regular expression pattern in the ECMA 262/Perl 5 format, while the value is a jsonSchema. If the pattern matches the name of a property on the instance object, the value of the instance's property MUST be valid against the pattern name's jsonSchema value.

properties

private Map<String, JsonSchema> properties

This attribute is an object with property definitions that define the valid values of instance object property values. When the instance value is an object, the property values of the instance object MUST conform to the property definitions in this object. In this object, each property definition's value MUST be a jsonSchema, and the property's name MUST be the name of the instance property that it defines. The instance property value MUST be valid according to the jsonSchema from the property definition. Properties are considered unordered, the order of the instance properties MAY be in any order.

Constructor Details

ObjectSchema

public ObjectSchema()

Method Details

addSchemaDependency

public boolean addSchemaDependency(String depender,
 JsonSchema parentMustMatch)

addSimpleDependency

public boolean addSimpleDependency(String depender,
 String dependsOn)

getType

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

Specified by:

getType in class JsonSchema

isObjectSchema

public boolean isObjectSchema()

Description copied from class: JsonSchema

determine if this JsonSchema is an ObjectSchema.

Overrides:

isObjectSchema in class JsonSchema

Returns:

true if this JsonSchema is an ObjectSchema, false otherwise

asObjectSchema

public ObjectSchema asObjectSchema()

Description copied from class: JsonSchema

Attempt to return this JsonSchema as an ObjectSchema

Overrides:

asObjectSchema in class JsonSchema

Returns:

this as an ObjectSchema if possible, or null otherwise

getAdditionalProperties

public ObjectSchema.AdditionalProperties getAdditionalProperties()

getDependencies

public Map<String,Object> getDependencies()

getPatternProperties

public Map<String, JsonSchema> getPatternProperties()

getProperties

public Map<String, JsonSchema> getProperties()

putOptionalProperty

public void putOptionalProperty(com.fasterxml.jackson.databind.BeanProperty property,
 JsonSchema jsonSchema)

putOptionalProperty

public void putOptionalProperty(String name,
 JsonSchema jsonSchema)

putPatternProperty

public JsonSchema putPatternProperty(String regex,
 JsonSchema value)

putProperty

public JsonSchema putProperty(com.fasterxml.jackson.databind.BeanProperty property,
 JsonSchema value)

putProperty

public JsonSchema putProperty(String name,
 JsonSchema value)

rejectAdditionalProperties

public void rejectAdditionalProperties()

setAdditionalProperties

public void setAdditionalProperties(ObjectSchema.AdditionalProperties additionalProperties)

setDependencies

public void setDependencies(Map<String,Object> dependencies)

setPatternProperties

public void setPatternProperties(Map<String, JsonSchema> patternProperties)

setProperties

public void setProperties(Map<String, JsonSchema> properties)

equals

public boolean equals(Object obj)

Overrides:

equals in class ContainerTypeSchema

_equals

protected boolean _equals(ObjectSchema that)