Class JsonSchemaProperty.JsonSchemaPropertyBuilder

java.lang.Object

org.springframework.data.mongodb.core.schema.JsonSchemaProperty.JsonSchemaPropertyBuilder

Enclosing interface:

JsonSchemaProperty

public static class JsonSchemaProperty.JsonSchemaPropertyBuilder
extends Object

Builder for IdentifiableJsonSchemaProperty.

Since:

2.1

Author:

Christoph Strobl, Mark Paluch

Method Summary

Modifier and Type	Method	Description
IdentifiableJsonSchemaProperty<TypedJsonSchemaObject>	ofType(@Nullable Class<?> type)	Configure the JsonSchemaObject.Type for the property by deriving it from the given type.
IdentifiableJsonSchemaProperty<TypedJsonSchemaObject>	ofType(JsonSchemaObject.Type type)	Configure a JsonSchemaObject.Type for the property.
IdentifiableJsonSchemaProperty<TypedJsonSchemaObject>	with(TypedJsonSchemaObject schemaObject)	Configure a TypedJsonSchemaObject for the property.
IdentifiableJsonSchemaProperty<UntypedJsonSchemaObject>	withoutType()

Methods inherited from class java.lang.Object

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

Method Details

ofType

public IdentifiableJsonSchemaProperty<TypedJsonSchemaObject> ofType(JsonSchemaObject.Type type)

Configure a JsonSchemaObject.Type for the property.

Parameters:

type - must not be null.

Returns:

new instance of IdentifiableJsonSchemaProperty.

ofType

public IdentifiableJsonSchemaProperty<TypedJsonSchemaObject> ofType(@Nullable Class<?> type)

Configure the JsonSchemaObject.Type for the property by deriving it from the given type.

Parameters:

type - must not be null.

Returns:

new instance of IdentifiableJsonSchemaProperty.

Since:

2.2

with

public IdentifiableJsonSchemaProperty<TypedJsonSchemaObject> with(TypedJsonSchemaObject schemaObject)

Configure a TypedJsonSchemaObject for the property.

Parameters:

schemaObject - must not be null.

Returns:

new instance of IdentifiableJsonSchemaProperty.

withoutType

public IdentifiableJsonSchemaProperty<UntypedJsonSchemaObject> withoutType()

Returns:

an untyped IdentifiableJsonSchemaProperty.