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
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 TypeMethodDescriptionallOf
(Collection<JsonSchemaObject> allOf) The field value must match all specified schemas.anyOf
(Collection<JsonSchemaObject> anyOf) The field value must match at least one of the specified schemas.description
(String description) Set the description.Auto generate the description if not explicitly set.protected String
Customization hook for creating description out of defined values.
Called byTypedJsonSchemaObject.toDocument()
when no explicitTypedJsonSchemaObject.description(java.lang.String)
is set.Set minimum to givenmin
value and exclusiveMinimum to true.Set minimum to givenmin
value and exclusiveMinimum to false.Set maximum to givenmax
value and exclusiveMaximum to true.Set maximum to givenmax
value and exclusiveMaximum to false.multipleOf
(Number value) Set the value a valid field value must be the multiple of.notMatch
(JsonSchemaObject notMatch) The field value must not match the specified schemas.oneOf
(Collection<JsonSchemaObject> oneOf) The field value must match exactly one of the specified schemas.possibleValues
(Collection<? extends Object> possibleValues) enumerates all possible values of the field.org.bson.Document
Create the JSON schema complyingDocument
representation.Set theRange
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
-
Method Details
-
multipleOf
Set the value a valid field value must be the multiple of.- Parameters:
value
- must not be null.- Returns:
- must not be null.
-
within
Set theRange
of valid field values translating to minimum, exclusiveMinimum, maximum and exclusiveMaximum.- Parameters:
range
- must not be null.- Returns:
- new instance of
TypedJsonSchemaObject.NumericJsonSchemaObject
.
-
gt
Set minimum to givenmin
value and exclusiveMinimum to true.- Parameters:
min
- must not be null.- Returns:
- new instance of
TypedJsonSchemaObject.NumericJsonSchemaObject
.
-
gte
Set minimum to givenmin
value and exclusiveMinimum to false.- Parameters:
min
- must not be null.- Returns:
- new instance of
TypedJsonSchemaObject.NumericJsonSchemaObject
.
-
lt
Set maximum to givenmax
value and exclusiveMaximum to true.- Parameters:
max
- must not be null.- Returns:
- new instance of
TypedJsonSchemaObject.NumericJsonSchemaObject
.
-
lte
Set maximum to givenmax
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 classTypedJsonSchemaObject
- Parameters:
possibleValues
- must not be null.- Returns:
- new instance of
TypedJsonSchemaObject
.
-
allOf
Description copied from class:TypedJsonSchemaObject
The field value must match all specified schemas.- Overrides:
allOf
in classTypedJsonSchemaObject
- Parameters:
allOf
- must not be null.- Returns:
- new instance of
TypedJsonSchemaObject
.
-
anyOf
Description copied from class:TypedJsonSchemaObject
The field value must match at least one of the specified schemas.- Overrides:
anyOf
in classTypedJsonSchemaObject
- Parameters:
anyOf
- must not be null.- Returns:
- new instance of
TypedJsonSchemaObject
.
-
oneOf
Description copied from class:TypedJsonSchemaObject
The field value must match exactly one of the specified schemas.- Overrides:
oneOf
in classTypedJsonSchemaObject
- Parameters:
oneOf
- must not be null.- Returns:
- new instance of
TypedJsonSchemaObject
.
-
notMatch
Description copied from class:TypedJsonSchemaObject
The field value must not match the specified schemas.- Overrides:
notMatch
in classTypedJsonSchemaObject
- Parameters:
notMatch
- must not be null.- Returns:
- new instance of
TypedJsonSchemaObject
.
-
description
Description copied from class:TypedJsonSchemaObject
Set the description.- Overrides:
description
in classTypedJsonSchemaObject
- Parameters:
description
- must not be null.- Returns:
- new instance of
TypedJsonSchemaObject
.
-
generatedDescription
Description copied from class:TypedJsonSchemaObject
Auto generate the description if not explicitly set.- Overrides:
generatedDescription
in classTypedJsonSchemaObject
- Returns:
- new instance of
TypedJsonSchemaObject
.
-
toDocument
public org.bson.Document toDocument()Description copied from class:TypedJsonSchemaObject
Create the JSON schema complyingDocument
representation. This includes type, description and the fields ofUntypedJsonSchemaObject.Restrictions.toDocument()
if set.- Specified by:
toDocument
in interfaceJsonSchemaObject
- Overrides:
toDocument
in classTypedJsonSchemaObject
- Returns:
- never null.
-
generateDescription
Description copied from class:TypedJsonSchemaObject
Customization hook for creating description out of defined values.
Called byTypedJsonSchemaObject.toDocument()
when no explicitTypedJsonSchemaObject.description(java.lang.String)
is set.- Overrides:
generateDescription
in classTypedJsonSchemaObject
- Returns:
- can be null.
-