Package org.springframework.data.mongodb.core.schema

Class TypedJsonSchemaObject.ObjectJsonSchemaObject

java.lang.Object

org.springframework.data.mongodb.core.schema.UntypedJsonSchemaObject

org.springframework.data.mongodb.core.schema.TypedJsonSchemaObject

org.springframework.data.mongodb.core.schema.TypedJsonSchemaObject.ObjectJsonSchemaObject

All Implemented Interfaces:

JsonSchemaObject

Enclosing class:

TypedJsonSchemaObject

public static class TypedJsonSchemaObject.ObjectJsonSchemaObject
extends TypedJsonSchemaObject

JsonSchemaObject implementation of type : 'object' schema elements.
Provides programmatic access to schema specifics like required, properties, patternProperties,... via a fluent API producing immutable schema objects.

Since:

2.1

Author:

Christoph Strobl

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.data.mongodb.core.schema.TypedJsonSchemaObject

TypedJsonSchemaObject.ArrayJsonSchemaObject, TypedJsonSchemaObject.BooleanJsonSchemaObject, TypedJsonSchemaObject.NumericJsonSchemaObject, TypedJsonSchemaObject.ObjectJsonSchemaObject, TypedJsonSchemaObject.StringJsonSchemaObject

Nested classes/interfaces inherited from interface org.springframework.data.mongodb.core.schema.JsonSchemaObject

JsonSchemaObject.Type

Field Summary

Fields inherited from class org.springframework.data.mongodb.core.schema.TypedJsonSchemaObject

types

Fields inherited from class org.springframework.data.mongodb.core.schema.UntypedJsonSchemaObject

description, generateDescription, restrictions

Constructor Summary

Constructors

Constructor	Description
ObjectJsonSchemaObject()

Method Summary

Modifier and Type	Method	Description
TypedJsonSchemaObject.ObjectJsonSchemaObject	additionalProperties(boolean additionalPropertiesAllowed)	If set to false, additional fields besides properties(JsonSchemaProperty...)/patternProperties(JsonSchemaProperty...) are not allowed.
TypedJsonSchemaObject.ObjectJsonSchemaObject	additionalProperties(TypedJsonSchemaObject.ObjectJsonSchemaObject schema)	If specified, additional fields must validate against the given schema.
TypedJsonSchemaObject.ObjectJsonSchemaObject	allOf(Collection<JsonSchemaObject> allOf)	The field value must match all specified schemas.
TypedJsonSchemaObject.ObjectJsonSchemaObject	anyOf(Collection<JsonSchemaObject> anyOf)	The field value must match at least one of the specified schemas.
TypedJsonSchemaObject.ObjectJsonSchemaObject	description(String description)	Set the description.
TypedJsonSchemaObject.ObjectJsonSchemaObject	generatedDescription()	Auto generate the description if not explicitly set.
protected String	generateDescription()	Customization hook for creating description out of defined values. Called by TypedJsonSchemaObject.toDocument() when no explicit TypedJsonSchemaObject.description(java.lang.String) is set.
List<JsonSchemaProperty>	getProperties()
TypedJsonSchemaObject.ObjectJsonSchemaObject	maxProperties(int count)	Define the maxProperties.
TypedJsonSchemaObject.ObjectJsonSchemaObject	minProperties(int count)	Define the minProperties.
TypedJsonSchemaObject.ObjectJsonSchemaObject	notMatch(JsonSchemaObject notMatch)	The field value must not match the specified schemas.
TypedJsonSchemaObject.ObjectJsonSchemaObject	oneOf(Collection<JsonSchemaObject> oneOf)	The field value must match exactly one of the specified schemas.
TypedJsonSchemaObject.ObjectJsonSchemaObject	patternProperties(JsonSchemaProperty... regularExpressions)	Append regular expression patterns along with the JsonSchemaObject matching properties validating against.
TypedJsonSchemaObject.ObjectJsonSchemaObject	possibleValues(Collection<? extends Object> possibleValues)	enumerates all possible values of the field.
TypedJsonSchemaObject.ObjectJsonSchemaObject	properties(JsonSchemaProperty... properties)	Append the objects properties along with the JsonSchemaObject validating against.
TypedJsonSchemaObject.ObjectJsonSchemaObject	propertiesCount(Range<Integer> range)	Define the minProperties and maxProperties via the given Range. In-/Exclusions via range bounds are not taken into account.
TypedJsonSchemaObject.ObjectJsonSchemaObject	property(JsonSchemaProperty property)	Append the objects property along with the JsonSchemaObject validating against.
TypedJsonSchemaObject.ObjectJsonSchemaObject	required(String... properties)	Define the Object’s required properties.
org.bson.Document	toDocument()	Create the JSON schema complying Document representation.

Methods inherited from class org.springframework.data.mongodb.core.schema.TypedJsonSchemaObject

getTypes, of

Methods inherited from class org.springframework.data.mongodb.core.schema.UntypedJsonSchemaObject

newInstance

Methods inherited from class java.lang.Object

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

Constructor Details

ObjectJsonSchemaObject

public ObjectJsonSchemaObject()

Method Details

propertiesCount

public TypedJsonSchemaObject.ObjectJsonSchemaObject propertiesCount(Range<Integer> range)

Define the minProperties and maxProperties via the given Range.
In-/Exclusions via range bounds are not taken into account.

Parameters:

range - must not be null. Consider Range.unbounded() instead.

Returns:

new instance of TypedJsonSchemaObject.ObjectJsonSchemaObject.

minProperties

public TypedJsonSchemaObject.ObjectJsonSchemaObject minProperties(int count)

Define the minProperties.

Parameters:

count - the allowed minimal number of properties.

Returns:

new instance of TypedJsonSchemaObject.ObjectJsonSchemaObject.

maxProperties

public TypedJsonSchemaObject.ObjectJsonSchemaObject maxProperties(int count)

Define the maxProperties.

Parameters:

count - the allowed maximum number of properties.

Returns:

new instance of TypedJsonSchemaObject.ObjectJsonSchemaObject.

required

public TypedJsonSchemaObject.ObjectJsonSchemaObject required(String... properties)

Define the Object’s required properties.

Parameters:

properties - the names of required properties.

Returns:

new instance of TypedJsonSchemaObject.ObjectJsonSchemaObject.

additionalProperties

public TypedJsonSchemaObject.ObjectJsonSchemaObject additionalProperties(boolean additionalPropertiesAllowed)

If set to false, additional fields besides properties(JsonSchemaProperty...)/patternProperties(JsonSchemaProperty...) are not allowed.

Parameters:

additionalPropertiesAllowed -

Returns:

new instance of TypedJsonSchemaObject.ObjectJsonSchemaObject.

additionalProperties

public TypedJsonSchemaObject.ObjectJsonSchemaObject additionalProperties(TypedJsonSchemaObject.ObjectJsonSchemaObject schema)

If specified, additional fields must validate against the given schema.

Parameters:

schema - must not be null.

Returns:

new instance of TypedJsonSchemaObject.ObjectJsonSchemaObject.

properties

public TypedJsonSchemaObject.ObjectJsonSchemaObject properties(JsonSchemaProperty... properties)

Append the objects properties along with the JsonSchemaObject validating against.

Parameters:

properties - must not be null.

Returns:

new instance of TypedJsonSchemaObject.ObjectJsonSchemaObject.

patternProperties

public TypedJsonSchemaObject.ObjectJsonSchemaObject patternProperties(JsonSchemaProperty... regularExpressions)

Append regular expression patterns along with the JsonSchemaObject matching properties validating against.

Parameters:

regularExpressions - must not be null.

Returns:

new instance of TypedJsonSchemaObject.ObjectJsonSchemaObject.

property

public TypedJsonSchemaObject.ObjectJsonSchemaObject property(JsonSchemaProperty property)

Append the objects property along with the JsonSchemaObject validating against.

Parameters:

property - must not be null.

Returns:

new instance of TypedJsonSchemaObject.ObjectJsonSchemaObject.

possibleValues

public TypedJsonSchemaObject.ObjectJsonSchemaObject possibleValues(Collection<? extends Object> possibleValues)

Description copied from class: TypedJsonSchemaObject

enumerates all possible values of the field.

Overrides:

possibleValues in class TypedJsonSchemaObject

Parameters:

possibleValues - must not be null.

Returns:

new instance of TypedJsonSchemaObject.

allOf

public TypedJsonSchemaObject.ObjectJsonSchemaObject allOf(Collection<JsonSchemaObject> allOf)

Description copied from class: TypedJsonSchemaObject

The field value must match all specified schemas.

Overrides:

allOf in class TypedJsonSchemaObject

Parameters:

allOf - must not be null.

Returns:

new instance of TypedJsonSchemaObject.

anyOf

public TypedJsonSchemaObject.ObjectJsonSchemaObject anyOf(Collection<JsonSchemaObject> anyOf)

Description copied from class: TypedJsonSchemaObject

The field value must match at least one of the specified schemas.

Overrides:

anyOf in class TypedJsonSchemaObject

Parameters:

anyOf - must not be null.

Returns:

new instance of TypedJsonSchemaObject.

oneOf

public TypedJsonSchemaObject.ObjectJsonSchemaObject oneOf(Collection<JsonSchemaObject> oneOf)

Description copied from class: TypedJsonSchemaObject

The field value must match exactly one of the specified schemas.

Overrides:

oneOf in class TypedJsonSchemaObject

Parameters:

oneOf - must not be null.

Returns:

new instance of TypedJsonSchemaObject.

notMatch

public TypedJsonSchemaObject.ObjectJsonSchemaObject notMatch(JsonSchemaObject notMatch)

Description copied from class: TypedJsonSchemaObject

The field value must not match the specified schemas.

Overrides:

notMatch in class TypedJsonSchemaObject

Parameters:

notMatch - must not be null.

Returns:

new instance of TypedJsonSchemaObject.

description

public TypedJsonSchemaObject.ObjectJsonSchemaObject description(String description)

Description copied from class: TypedJsonSchemaObject

Set the description.

Overrides:

description in class TypedJsonSchemaObject

Parameters:

description - must not be null.

Returns:

new instance of TypedJsonSchemaObject.

generatedDescription

public TypedJsonSchemaObject.ObjectJsonSchemaObject generatedDescription()

Description copied from class: TypedJsonSchemaObject

Auto generate the description if not explicitly set.

Overrides:

generatedDescription in class TypedJsonSchemaObject

Returns:

new instance of TypedJsonSchemaObject.

getProperties

public List<JsonSchemaProperty> getProperties()

toDocument

public org.bson.Document toDocument()

Description copied from class: TypedJsonSchemaObject

Create the JSON schema complying Document representation. This includes type, description and the fields of UntypedJsonSchemaObject.Restrictions.toDocument() if set.

Specified by:

toDocument in interface JsonSchemaObject

Overrides:

toDocument in class TypedJsonSchemaObject

Returns:

never null.

generateDescription

protected String generateDescription()

Description copied from class: TypedJsonSchemaObject

Customization hook for creating description out of defined values.
Called by TypedJsonSchemaObject.toDocument() when no explicit TypedJsonSchemaObject.description(java.lang.String) is set.

Overrides:

generateDescription in class TypedJsonSchemaObject

Returns:

can be null.