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

Class TypedJsonSchemaObject.NumericJsonSchemaObject

java.lang.Object

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

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

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

All Implemented Interfaces:

JsonSchemaObject

Enclosing class:

TypedJsonSchemaObject

public static class TypedJsonSchemaObject.NumericJsonSchemaObject
extends TypedJsonSchemaObject

JsonSchemaObject implementation of type : 'number', bsonType : 'int', bsonType : 'long', bsonType : 'double' and bsonType : 'decimal128' schema elements.
Provides programmatic access to schema specifics like multipleOf, minimum, maximum,... 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

Method Summary

Modifier and Type	Method	Description
TypedJsonSchemaObject.NumericJsonSchemaObject	allOf(Collection<JsonSchemaObject> allOf)	The field value must match all specified schemas.
TypedJsonSchemaObject.NumericJsonSchemaObject	anyOf(Collection<JsonSchemaObject> anyOf)	The field value must match at least one of the specified schemas.
TypedJsonSchemaObject.NumericJsonSchemaObject	description(String description)	Set the description.
TypedJsonSchemaObject.NumericJsonSchemaObject	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.
TypedJsonSchemaObject.NumericJsonSchemaObject	gt(Number min)	Set minimum to given min value and exclusiveMinimum to true.
TypedJsonSchemaObject.NumericJsonSchemaObject	gte(Number min)	Set minimum to given min value and exclusiveMinimum to false.
TypedJsonSchemaObject.NumericJsonSchemaObject	lt(Number max)	Set maximum to given max value and exclusiveMaximum to true.
TypedJsonSchemaObject.NumericJsonSchemaObject	lte(Number max)	Set maximum to given max value and exclusiveMaximum to false.
TypedJsonSchemaObject.NumericJsonSchemaObject	multipleOf(Number value)	Set the value a valid field value must be the multiple of.
TypedJsonSchemaObject.NumericJsonSchemaObject	notMatch(JsonSchemaObject notMatch)	The field value must not match the specified schemas.
TypedJsonSchemaObject.NumericJsonSchemaObject	oneOf(Collection<JsonSchemaObject> oneOf)	The field value must match exactly one of the specified schemas.
TypedJsonSchemaObject.NumericJsonSchemaObject	possibleValues(Collection<? extends Object> possibleValues)	enumerates all possible values of the field.
org.bson.Document	toDocument()	Create the JSON schema complying Document representation.
TypedJsonSchemaObject.NumericJsonSchemaObject	within(Range<? extends Number> range)	Set the Range of valid field values translating to minimum, exclusiveMinimum, maximum and exclusiveMaximum.

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

Method Details

multipleOf

public TypedJsonSchemaObject.NumericJsonSchemaObject multipleOf(Number value)

Set the value a valid field value must be the multiple of.

Parameters:

value - must not be null.

Returns:

must not be null.

within

public TypedJsonSchemaObject.NumericJsonSchemaObject within(Range<? extends Number> range)

Set the Range of valid field values translating to minimum, exclusiveMinimum, maximum and exclusiveMaximum.

Parameters:

range - must not be null.

Returns:

new instance of TypedJsonSchemaObject.NumericJsonSchemaObject.

gt

public TypedJsonSchemaObject.NumericJsonSchemaObject gt(Number min)

Set minimum to given min value and exclusiveMinimum to true.

Parameters:

min - must not be null.

Returns:

new instance of TypedJsonSchemaObject.NumericJsonSchemaObject.

gte

public TypedJsonSchemaObject.NumericJsonSchemaObject gte(Number min)

Set minimum to given min value and exclusiveMinimum to false.

Parameters:

min - must not be null.

Returns:

new instance of TypedJsonSchemaObject.NumericJsonSchemaObject.

lt

public TypedJsonSchemaObject.NumericJsonSchemaObject lt(Number max)

Set maximum to given max value and exclusiveMaximum to true.

Parameters:

max - must not be null.

Returns:

new instance of TypedJsonSchemaObject.NumericJsonSchemaObject.

lte

public TypedJsonSchemaObject.NumericJsonSchemaObject lte(Number max)

Set maximum to given max value and exclusiveMaximum to false.

Parameters:

max - must not be null.

Returns:

new instance of TypedJsonSchemaObject.NumericJsonSchemaObject.

possibleValues

public TypedJsonSchemaObject.NumericJsonSchemaObject 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.NumericJsonSchemaObject 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.NumericJsonSchemaObject 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.NumericJsonSchemaObject 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.NumericJsonSchemaObject 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.NumericJsonSchemaObject 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.NumericJsonSchemaObject generatedDescription()

Description copied from class: TypedJsonSchemaObject

Auto generate the description if not explicitly set.

Overrides:

generatedDescription in class TypedJsonSchemaObject

Returns:

new instance of TypedJsonSchemaObject.

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.