com.fasterxml.jackson.module.jsonSchema.types

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

Author:

jphelan

Nested Class Summary

Nested Classes

Modifier and Type	Class and 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.

Constructor Summary

Constructors

Constructor and Description
ObjectSchema()

Method Summary

Methods

Modifier and Type	Method and Description
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()
List<ObjectSchema.Dependency>	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(List<ObjectSchema.Dependency> dependencies)
void	setPatternProperties(Map<String,JsonSchema> patternProperties)
void	setProperties(Map<String,JsonSchema> properties)

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

asContainerSchema, getEnums, isContainerTypeSchema, setEnums

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

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

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

asAnySchema, asArraySchema, asBooleanSchema, asIntegerSchema, asNullSchema, asNumberSchema, asStringSchema, asUnionTypeSchema, asValueSchemaSchema, enrichWithBeanProperty, get$ref, get$schema, getDisallow, getExtends, getId, getRequired, isAnySchema, isArraySchema, isBooleanSchema, isIntegerSchema, isNullSchema, isNumberSchema, 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

ObjectSchema

public ObjectSchema()

Method Detail

addSchemaDependency

public boolean addSchemaDependency(String depender,
                          JsonSchema parentMustMatch)

addSimpleDependency

public boolean addSimpleDependency(String depender,
                          String dependsOn)

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

equals

public boolean equals(Object obj)

Overrides:

equals in class ContainerTypeSchema

getAdditionalProperties

public ObjectSchema.AdditionalProperties getAdditionalProperties()

getDependencies

public List<ObjectSchema.Dependency> getDependencies()

getPatternProperties

public Map<String,JsonSchema> getPatternProperties()

getProperties

public Map<String,JsonSchema> getProperties()

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

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(List<ObjectSchema.Dependency> dependencies)

setPatternProperties

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

setProperties

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