Class TypedJsonSchemaObject.BooleanJsonSchemaObject
java.lang.Object
org.springframework.data.mongodb.core.schema.UntypedJsonSchemaObject
org.springframework.data.mongodb.core.schema.TypedJsonSchemaObject
org.springframework.data.mongodb.core.schema.TypedJsonSchemaObject.BooleanJsonSchemaObject
- All Implemented Interfaces:
JsonSchemaObject
- Enclosing class:
- TypedJsonSchemaObject
JsonSchemaObject
implementation of type : 'boolean'
schema elements.Provides programmatic access to schema specifics via a fluent API producing immutable
schema objects
.- Since:
- 2.1
- Author:
- Christoph Strobl, Mark Paluch
-
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.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.Methods inherited from class org.springframework.data.mongodb.core.schema.TypedJsonSchemaObject
getTypes, of, toDocument
Methods inherited from class org.springframework.data.mongodb.core.schema.UntypedJsonSchemaObject
newInstance
-
Method Details
-
possibleValues
public TypedJsonSchemaObject.BooleanJsonSchemaObject 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
.
-
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.
-