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

public static class TypedJsonSchemaObject.BooleanJsonSchemaObject
extends 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 TypedJsonSchemaObject

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

Nested classes/interfaces inherited from interface JsonSchemaObject

JsonSchemaObject.Type

Field Summary

Fields inherited from class TypedJsonSchemaObject

types

Fields inherited from class UntypedJsonSchemaObject

description, generateDescription, restrictions

Method Summary

Modifier and Type	Method	Description
TypedJsonSchemaObject.BooleanJsonSchemaObject	allOf(Collection<JsonSchemaObject> allOf)	The field value must match all specified schemas.
TypedJsonSchemaObject.BooleanJsonSchemaObject	anyOf(Collection<JsonSchemaObject> anyOf)	The field value must match at least one of the specified schemas.
TypedJsonSchemaObject.BooleanJsonSchemaObject	description(String description)	Set the description.
TypedJsonSchemaObject.BooleanJsonSchemaObject	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(String) is set.
TypedJsonSchemaObject.BooleanJsonSchemaObject	notMatch(JsonSchemaObject notMatch)	The field value must not match the specified schemas.
TypedJsonSchemaObject.BooleanJsonSchemaObject	oneOf(Collection<JsonSchemaObject> oneOf)	The field value must match exactly one of the specified schemas.
TypedJsonSchemaObject.BooleanJsonSchemaObject	possibleValues(Collection<? extends Object> possibleValues)	enumerates all possible values of the field.

Methods inherited from class TypedJsonSchemaObject

getTypes, of, toDocument

Methods inherited from class UntypedJsonSchemaObject

newInstance

Methods inherited from class Object

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

Method Details

possibleValues

@Contract("_ -> new")
public TypedJsonSchemaObject.BooleanJsonSchemaObject 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

@Contract("_ -> new")
public TypedJsonSchemaObject.BooleanJsonSchemaObject 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

@Contract("_ -> new")
public TypedJsonSchemaObject.BooleanJsonSchemaObject 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

@Contract("_ -> new")
public TypedJsonSchemaObject.BooleanJsonSchemaObject 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

@Contract("_ -> new")
public TypedJsonSchemaObject.BooleanJsonSchemaObject 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

@Contract("_ -> new")
public TypedJsonSchemaObject.BooleanJsonSchemaObject 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

@Contract("_ -> new")
public TypedJsonSchemaObject.BooleanJsonSchemaObject generatedDescription()

Description copied from class: TypedJsonSchemaObject

Auto generate the description if not explicitly set.

Overrides:

generatedDescription in class TypedJsonSchemaObject

Returns:

new instance of TypedJsonSchemaObject.

generateDescription

@Contract("-> new")
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(String) is set.

Overrides:

generateDescription in class TypedJsonSchemaObject

Returns:

can be null.