org.springframework.data.mongodb.core.schema

Class TypedJsonSchemaObject.StringJsonSchemaObject

java.lang.Object

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

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

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

All Implemented Interfaces:

JsonSchemaObject

Enclosing class:

TypedJsonSchemaObject

public static class TypedJsonSchemaObject.StringJsonSchemaObject
extends TypedJsonSchemaObject

JsonSchemaObject implementation of type : 'string' schema elements.
Provides programmatic access to schema specifics like minLength, maxLength, pattern,... 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 and Description
TypedJsonSchemaObject.StringJsonSchemaObject	allOf(Collection<JsonSchemaObject> allOf) The field value must match all specified schemas.
TypedJsonSchemaObject.StringJsonSchemaObject	anyOf(Collection<JsonSchemaObject> anyOf) The field value must match at least one of the specified schemas.
TypedJsonSchemaObject.StringJsonSchemaObject	description(String description) Set the description.
TypedJsonSchemaObject.StringJsonSchemaObject	generatedDescription() Auto generate the description if not explicitly set.
protected String	generateDescription() Customization hook for creating description out of defined values.
TypedJsonSchemaObject.StringJsonSchemaObject	length(Range<Integer> range) Define the valid length range (minLength and maxLength) for a valid field.
TypedJsonSchemaObject.StringJsonSchemaObject	matching(String pattern) Define the regex pattern to validate field values against.
TypedJsonSchemaObject.StringJsonSchemaObject	maxLength(int length) Define the valid length range (maxLength) for a valid field.
TypedJsonSchemaObject.StringJsonSchemaObject	minLength(int length) Define the valid length range (minLength) for a valid field.
TypedJsonSchemaObject.StringJsonSchemaObject	notMatch(JsonSchemaObject notMatch) The field value must not match the specified schemas.
TypedJsonSchemaObject.StringJsonSchemaObject	oneOf(Collection<JsonSchemaObject> oneOf) The field value must match exactly one of the specified schemas.
TypedJsonSchemaObject.StringJsonSchemaObject	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 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

Methods inherited from interface org.springframework.data.mongodb.core.schema.JsonSchemaObject

array, bool, date, nil, number, object, of, of, string, timestamp, untyped

Method Detail

length

public TypedJsonSchemaObject.StringJsonSchemaObject length(Range<Integer> range)

Define the valid length range (minLength and maxLength) for a valid field.

Parameters:

range - must not be null.

Returns:

new instance of TypedJsonSchemaObject.StringJsonSchemaObject.

minLength

public TypedJsonSchemaObject.StringJsonSchemaObject minLength(int length)

Define the valid length range (minLength) for a valid field.

Parameters:

length -

Returns:

new instance of TypedJsonSchemaObject.StringJsonSchemaObject.

maxLength

public TypedJsonSchemaObject.StringJsonSchemaObject maxLength(int length)

Define the valid length range (maxLength) for a valid field.

Parameters:

length -

Returns:

new instance of TypedJsonSchemaObject.StringJsonSchemaObject.

matching

public TypedJsonSchemaObject.StringJsonSchemaObject matching(String pattern)

Define the regex pattern to validate field values against.

Parameters:

pattern - must not be null.

Returns:

new instance of TypedJsonSchemaObject.StringJsonSchemaObject.

possibleValues

public TypedJsonSchemaObject.StringJsonSchemaObject 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.StringJsonSchemaObject 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.StringJsonSchemaObject 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.StringJsonSchemaObject 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.StringJsonSchemaObject 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.StringJsonSchemaObject 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.StringJsonSchemaObject 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 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.