org.helenus.jackson.jsonSchema.types

Class MapTypesSchema

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

org.helenus.jackson.jsonSchema.types.MapTypesSchema

public class MapTypesSchema
extends com.fasterxml.jackson.module.jsonSchema.types.ObjectSchema

The MapTypesSchema class extends the ObjectSchema class to provide additional information about the Java map being defined.

Since:

1.0

Version:

1 - Jun 27, 2016 - paouelle - Creation

Author:

The Helenus Driver Project Authors

Copyright:

2015-2016 The Helenus Driver Project Authors

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MapTypesSchema.AdditionalProperties The AdditionalProperties class defines additional properties used for a map to represent both the keys and values schemas.

Nested classes/interfaces inherited from class com.fasterxml.jackson.module.jsonSchema.types.ObjectSchema

com.fasterxml.jackson.module.jsonSchema.types.ObjectSchema.Dependency, com.fasterxml.jackson.module.jsonSchema.types.ObjectSchema.NoAdditionalProperties, com.fasterxml.jackson.module.jsonSchema.types.ObjectSchema.SchemaAdditionalProperties, com.fasterxml.jackson.module.jsonSchema.types.ObjectSchema.SchemaDependency, com.fasterxml.jackson.module.jsonSchema.types.ObjectSchema.SimpleDependency

Field Summary

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

Constructor and Description
MapTypesSchema() Instantiates a new MapTypesSchema object.
MapTypesSchema(com.fasterxml.jackson.module.jsonSchema.types.ObjectSchema schema) Instantiates a new MapTypesSchema object.

Method Summary

Modifier and Type	Method and Description
MapTypesSchema.AdditionalProperties	getAdditionalProperties()
com.fasterxml.jackson.module.jsonSchema.JsonSchema	getKeysSchema() Gets the schema for the map keys.
com.fasterxml.jackson.databind.JavaType	getKeysType() Gets the type for the map keys.
com.fasterxml.jackson.module.jsonSchema.JsonSchema	getValuesSchema() Gets the schema for the map values.
com.fasterxml.jackson.databind.JavaType	getValuesType() Gets the type for the map values.
void	setAdditionalProperties(com.fasterxml.jackson.module.jsonSchema.types.ObjectSchema.AdditionalProperties additionalProperties)
void	setKeysSchema(com.fasterxml.jackson.module.jsonSchema.JsonSchema keys) Sets the schema for the map keys.
void	setKeysType(com.fasterxml.jackson.databind.JavaType keys) Sets the type for the map keys.
void	setValuesSchema(com.fasterxml.jackson.module.jsonSchema.JsonSchema values) Sets the schema for the map values.
void	setValuesType(com.fasterxml.jackson.databind.JavaType values) Sets the type for the map values.

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

_equals, addSchemaDependency, addSimpleDependency, asObjectSchema, equals, getDependencies, getPatternProperties, getProperties, getType, isObjectSchema, putOptionalProperty, putOptionalProperty, putPatternProperty, putProperty, putProperty, rejectAdditionalProperties, setDependencies, setPatternProperties, setProperties

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

_equals, asContainerSchema, 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, asArraySchema, asBooleanSchema, asIntegerSchema, asNullSchema, asNumberSchema, asStringSchema, asUnionTypeSchema, asValueSchemaSchema, 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 java.lang.Object

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

Constructor Detail

MapTypesSchema

public MapTypesSchema(com.fasterxml.jackson.module.jsonSchema.types.ObjectSchema schema)

Instantiates a new MapTypesSchema object.

Parameters:

schema - the object schema representing the map type to copy

Throws:

IllegalArgumentException - if the schema doesn't represent a map

MapTypesSchema

public MapTypesSchema()

Instantiates a new MapTypesSchema object.

Method Detail

getAdditionalProperties

public MapTypesSchema.AdditionalProperties getAdditionalProperties()

Overrides:

getAdditionalProperties in class com.fasterxml.jackson.module.jsonSchema.types.ObjectSchema

See Also:

ObjectSchema.getAdditionalProperties()

setAdditionalProperties

public void setAdditionalProperties(com.fasterxml.jackson.module.jsonSchema.types.ObjectSchema.AdditionalProperties additionalProperties)

Overrides:

setAdditionalProperties in class com.fasterxml.jackson.module.jsonSchema.types.ObjectSchema

Throws:

IllegalArgumentException - if the properties doesn't represent additional map properties

See Also:

ObjectSchema.setAdditionalProperties(com.fasterxml.jackson.module.jsonSchema.types.ObjectSchema.AdditionalProperties)

getKeysSchema

public com.fasterxml.jackson.module.jsonSchema.JsonSchema getKeysSchema()

Gets the schema for the map keys.

Returns:

the schema for the map keys

setKeysSchema

public void setKeysSchema(com.fasterxml.jackson.module.jsonSchema.JsonSchema keys)

Sets the schema for the map keys.

Parameters:

keys - the schema for the map keys

getKeysType

public com.fasterxml.jackson.databind.JavaType getKeysType()

Gets the type for the map keys.

Returns:

the type for the map keys

setKeysType

public void setKeysType(com.fasterxml.jackson.databind.JavaType keys)

Sets the type for the map keys.

Parameters:

keys - the type for the map keys

getValuesSchema

public com.fasterxml.jackson.module.jsonSchema.JsonSchema getValuesSchema()

Gets the schema for the map values.

Returns:

the schema for the map values

setValuesSchema

public void setValuesSchema(com.fasterxml.jackson.module.jsonSchema.JsonSchema values)

Sets the schema for the map values.

Parameters:

values - the schema for the map values

getValuesType

public com.fasterxml.jackson.databind.JavaType getValuesType()

Gets the type for the map values.

Returns:

the type for the map values

setValuesType

public void setValuesType(com.fasterxml.jackson.databind.JavaType values)

Sets the type for the map values.

Parameters:

values - the type for the map values