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

Class IdentifiableJsonSchemaProperty.RequiredJsonSchemaProperty

java.lang.Object

org.springframework.data.mongodb.core.schema.IdentifiableJsonSchemaProperty.RequiredJsonSchemaProperty

All Implemented Interfaces:

JsonSchemaObject, JsonSchemaProperty

Enclosing class:

IdentifiableJsonSchemaProperty<T extends JsonSchemaObject>

public static class IdentifiableJsonSchemaProperty.RequiredJsonSchemaProperty
extends Object
implements JsonSchemaProperty

Delegating JsonSchemaProperty implementation having a required flag for evaluation during schema creation process.

Since:

2.2

Author:

Christoph Strobl

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.data.mongodb.core.schema.JsonSchemaObject

JsonSchemaObject.Type

Nested classes/interfaces inherited from interface org.springframework.data.mongodb.core.schema.JsonSchemaProperty

JsonSchemaProperty.JsonSchemaPropertyBuilder

Method Summary

Modifier and Type	Method	Description
String	getIdentifier()	The identifier can be either the property name or the regex expression properties have to match when used along with TypedJsonSchemaObject.ObjectJsonSchemaObject.patternProperties(JsonSchemaProperty...).
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.
boolean	isRequired()
org.bson.Document	toDocument()	Get the MongoDB specific representation. The Document may contain fields (eg. like bsonType) not contained in the JsonSchema specification.

Methods inherited from class java.lang.Object

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

Method Details

getIdentifier

public String getIdentifier()

Description copied from interface: JsonSchemaProperty

The identifier can be either the property name or the regex expression properties have to match when used along with TypedJsonSchemaObject.ObjectJsonSchemaObject.patternProperties(JsonSchemaProperty...).

Specified by:

getIdentifier in interface JsonSchemaProperty

Returns:

never null.

getTypes

public Set<JsonSchemaObject.Type> getTypes()

Description copied from interface: JsonSchemaObject

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

Specified by:

getTypes in interface JsonSchemaObject

Returns:

never null.

toDocument

public org.bson.Document toDocument()

Description copied from interface: JsonSchemaObject

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.

Specified by:

toDocument in interface JsonSchemaObject

Returns:

never null.

isRequired

public boolean isRequired()

Specified by:

isRequired in interface JsonSchemaProperty

Returns:

false by default.