Module spring.data.mongodb

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

Interface JsonSchemaObject

All Known Subinterfaces:

JsonSchemaProperty

All Known Implementing Classes:

IdentifiableJsonSchemaProperty, IdentifiableJsonSchemaProperty.ArrayJsonSchemaProperty, IdentifiableJsonSchemaProperty.BooleanJsonSchemaProperty, IdentifiableJsonSchemaProperty.DateJsonSchemaProperty, IdentifiableJsonSchemaProperty.EncryptedJsonSchemaProperty, IdentifiableJsonSchemaProperty.NullJsonSchemaProperty, IdentifiableJsonSchemaProperty.NumericJsonSchemaProperty, IdentifiableJsonSchemaProperty.ObjectJsonSchemaProperty, IdentifiableJsonSchemaProperty.QueryableJsonSchemaProperty, IdentifiableJsonSchemaProperty.RequiredJsonSchemaProperty, IdentifiableJsonSchemaProperty.StringJsonSchemaProperty, IdentifiableJsonSchemaProperty.TimestampJsonSchemaProperty, IdentifiableJsonSchemaProperty.UntypedJsonSchemaProperty, TypedJsonSchemaObject, TypedJsonSchemaObject.ArrayJsonSchemaObject, TypedJsonSchemaObject.BooleanJsonSchemaObject, TypedJsonSchemaObject.NumericJsonSchemaObject, TypedJsonSchemaObject.ObjectJsonSchemaObject, TypedJsonSchemaObject.StringJsonSchemaObject, UntypedJsonSchemaObject

public interface JsonSchemaObject

Interface that can be implemented by objects that know how to serialize themselves to JSON schema using toDocument().
This class also declares factory methods for type-specific schema objects such as string() or object(). For example:

 JsonSchemaProperty.object("address").properties(JsonSchemaProperty.string("city").minLength(3));
 

Since:

2.1

Author:

Christoph Strobl, Mark Paluch

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	JsonSchemaObject.Type	Type represents either a JSON schema type or a MongoDB specific bsonType.

Method Summary

Modifier and Type	Method	Description
static TypedJsonSchemaObject.ArrayJsonSchemaObject	array()	Create a new JsonSchemaObject of type : 'array'.
static TypedJsonSchemaObject.BooleanJsonSchemaObject	bool()	Create a new JsonSchemaObject of type : 'boolean'.
static org.springframework.data.mongodb.core.schema.TypedJsonSchemaObject.DateJsonSchemaObject	date()	Create a new JsonSchemaObject of type : 'date'.
Set<JsonSchemaObject.Type>	getTypes()	Get the set of types defined for this schema element. The Set is likely to contain only one element in most cases.
static org.springframework.data.mongodb.core.schema.TypedJsonSchemaObject.NullJsonSchemaObject	nil()	Create a new JsonSchemaObject of type : 'null'.
static TypedJsonSchemaObject.NumericJsonSchemaObject	number()	Create a new JsonSchemaObject of type : 'number'.
static TypedJsonSchemaObject.ObjectJsonSchemaObject	object()	Create a new JsonSchemaObject of type : 'object'.
static TypedJsonSchemaObject	of(Class<?> type)	Create a new JsonSchemaObject matching the given type.
static TypedJsonSchemaObject	of(JsonSchemaObject.Type type)	Create a new JsonSchemaObject of given JsonSchemaObject.Type.
static TypedJsonSchemaObject.StringJsonSchemaObject	string()	Create a new JsonSchemaObject of type : 'string'.
static org.springframework.data.mongodb.core.schema.TypedJsonSchemaObject.TimestampJsonSchemaObject	timestamp()	Create a new JsonSchemaObject of type : 'timestamp'.
org.bson.Document	toDocument()	Get the MongoDB specific representation. The Document may contain fields (eg. like bsonType) not contained in the JsonSchema specification.
static UntypedJsonSchemaObject	untyped()	Create a new UntypedJsonSchemaObject.

Method Details

getTypes

Set<JsonSchemaObject.Type> getTypes()

Get the set of types defined for this schema element.
The Set is likely to contain only one element in most cases.

Returns:

never null.

toDocument

org.bson.Document toDocument()

Get the MongoDB specific representation.
The Document may contain fields (eg. like bsonType) not contained in the JsonSchema specification. It may also contain types not directly processable by the MongoDB java driver. Make sure to run the produced Document through the mapping infrastructure.

Returns:

never null.

object

static TypedJsonSchemaObject.ObjectJsonSchemaObject object()

Create a new JsonSchemaObject of type : 'object'.

Returns:

never null.

string

static TypedJsonSchemaObject.StringJsonSchemaObject string()

Create a new JsonSchemaObject of type : 'string'.

Returns:

never null.

number

static TypedJsonSchemaObject.NumericJsonSchemaObject number()

Create a new JsonSchemaObject of type : 'number'.

Returns:

never null.

array

static TypedJsonSchemaObject.ArrayJsonSchemaObject array()

Create a new JsonSchemaObject of type : 'array'.

Returns:

never null.

bool

static TypedJsonSchemaObject.BooleanJsonSchemaObject bool()

Create a new JsonSchemaObject of type : 'boolean'.

Returns:

never null.

nil

static org.springframework.data.mongodb.core.schema.TypedJsonSchemaObject.NullJsonSchemaObject nil()

Create a new JsonSchemaObject of type : 'null'.

Returns:

never null.

date

static org.springframework.data.mongodb.core.schema.TypedJsonSchemaObject.DateJsonSchemaObject date()

Create a new JsonSchemaObject of type : 'date'.

Returns:

never null.

timestamp

static org.springframework.data.mongodb.core.schema.TypedJsonSchemaObject.TimestampJsonSchemaObject timestamp()

Create a new JsonSchemaObject of type : 'timestamp'.

Returns:

never null.

of

static TypedJsonSchemaObject of(JsonSchemaObject.Type type)

Create a new JsonSchemaObject of given JsonSchemaObject.Type.

Returns:

never null.

untyped

static UntypedJsonSchemaObject untyped()

Create a new UntypedJsonSchemaObject.

Returns:

never null.

of

static TypedJsonSchemaObject of(@Nullable
 Class<?> type)

Create a new JsonSchemaObject matching the given type.

Parameters:

type - Java class to create a JsonSchemaObject for. May be null to create null type.

Returns:

never null.

Throws:

IllegalArgumentException - if type is not supported.