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

Class UntypedJsonSchemaObject

java.lang.Object

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

All Implemented Interfaces:

JsonSchemaObject

Direct Known Subclasses:

TypedJsonSchemaObject

public class UntypedJsonSchemaObject
extends Object
implements JsonSchemaObject

Common base for JsonSchemaObject with shared types and JsonSchemaObject.toDocument() implementation. Schema objects are immutable. Calling methods to configure properties creates a new object instance.

Since:

2.1

Author:

Christoph Strobl, Mark Paluch

Nested Class Summary

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

JsonSchemaObject.Type

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	description
protected final boolean	generateDescription
protected final org.springframework.data.mongodb.core.schema.UntypedJsonSchemaObject.Restrictions	restrictions

Method Summary

Modifier and Type	Method	Description
UntypedJsonSchemaObject	allOf(Collection<JsonSchemaObject> allOf)	The field value must match all specified schemas.
UntypedJsonSchemaObject	anyOf(Collection<JsonSchemaObject> anyOf)	The field value must match at least one of the specified schemas.
UntypedJsonSchemaObject	description(String description)	Set the description.
UntypedJsonSchemaObject	generatedDescription()	Auto generate the description if not explicitly set.
protected String	generateDescription()	Customization hook for creating description out of defined values. Called by toDocument() when no explicit description is set.
Set<JsonSchemaObject.Type>	getTypes()	Get the set of types defined for this schema element. The Set is likely to contain only one element in most cases.
static UntypedJsonSchemaObject	newInstance()	Create a new instance of UntypedJsonSchemaObject.
UntypedJsonSchemaObject	notMatch(JsonSchemaObject notMatch)	The field value must not match the specified schemas.
UntypedJsonSchemaObject	oneOf(Collection<JsonSchemaObject> oneOf)	The field value must match exactly one of the specified schemas.
UntypedJsonSchemaObject	possibleValues(Collection<? extends Object> possibleValues)	enumerates all possible values of the field.
org.bson.Document	toDocument()	Create the JSON schema complying Document representation.

Methods inherited from class java.lang.Object

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

Field Details

restrictions

protected final org.springframework.data.mongodb.core.schema.UntypedJsonSchemaObject.Restrictions restrictions

description

@Nullable
protected final String description

generateDescription

protected final boolean generateDescription

Method Details

newInstance

public static UntypedJsonSchemaObject newInstance()

Create a new instance of UntypedJsonSchemaObject.

Returns:

the new UntypedJsonSchemaObject.

getTypes

public Set<JsonSchemaObject.Type> getTypes()

Description copied from interface: JsonSchemaObject

Get the set of types defined for this schema element.
The Set is likely to contain only one element in most cases.

Specified by:

getTypes in interface JsonSchemaObject

Returns:

never null.

description

public UntypedJsonSchemaObject description(String description)

Set the description.

Parameters:

description - must not be null.

Returns:

new instance of TypedJsonSchemaObject.

generatedDescription

public UntypedJsonSchemaObject generatedDescription()

Auto generate the description if not explicitly set.

Returns:

new instance of TypedJsonSchemaObject.

possibleValues

public UntypedJsonSchemaObject possibleValues(Collection<? extends Object> possibleValues)

enumerates all possible values of the field.

Parameters:

possibleValues - must not be null.

Returns:

new instance of TypedJsonSchemaObject.

allOf

public UntypedJsonSchemaObject allOf(Collection<JsonSchemaObject> allOf)

The field value must match all specified schemas.

Parameters:

allOf - must not be null.

Returns:

new instance of TypedJsonSchemaObject.

anyOf

public UntypedJsonSchemaObject anyOf(Collection<JsonSchemaObject> anyOf)

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

Parameters:

anyOf - must not be null.

Returns:

new instance of TypedJsonSchemaObject.

oneOf

public UntypedJsonSchemaObject oneOf(Collection<JsonSchemaObject> oneOf)

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

Parameters:

oneOf - must not be null.

Returns:

new instance of TypedJsonSchemaObject.

notMatch

public UntypedJsonSchemaObject notMatch(JsonSchemaObject notMatch)

The field value must not match the specified schemas.

Parameters:

notMatch - must not be null.

Returns:

new instance of TypedJsonSchemaObject.

toDocument

public org.bson.Document toDocument()

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

Returns:

never null.

generateDescription

@Nullable
protected String generateDescription()

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

Returns:

can be null.