JsonSchemaProperty (Spring Data MongoDB

All Superinterfaces:

JsonSchemaObject

All Known Implementing Classes:

IdentifiableJsonSchemaProperty, IdentifiableJsonSchemaProperty.ArrayJsonSchemaProperty, IdentifiableJsonSchemaProperty.BooleanJsonSchemaProperty, IdentifiableJsonSchemaProperty.DateJsonSchemaProperty, IdentifiableJsonSchemaProperty.EncryptedJsonSchemaProperty, IdentifiableJsonSchemaProperty.NullJsonSchemaProperty, IdentifiableJsonSchemaProperty.NumericJsonSchemaProperty, IdentifiableJsonSchemaProperty.ObjectJsonSchemaProperty, IdentifiableJsonSchemaProperty.RequiredJsonSchemaProperty, IdentifiableJsonSchemaProperty.StringJsonSchemaProperty, IdentifiableJsonSchemaProperty.TimestampJsonSchemaProperty, IdentifiableJsonSchemaProperty.UntypedJsonSchemaProperty
```
public interface JsonSchemaProperty
extends JsonSchemaObject
```
A property or patternProperty within a JsonSchemaObject of type : 'object'.

Since:

2.1

Author:

Christoph Strobl, Mark Paluch

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class JsonSchemaProperty.JsonSchemaPropertyBuilder
Builder for IdentifiableJsonSchemaProperty.
- Nested classes/interfaces inherited from interface org.springframework.data.mongodb.core.schema.JsonSchemaObject
  JsonSchemaObject.Type

Nested Classes
Modifier and Type	Interface and Description
`static class`	`JsonSchemaProperty.JsonSchemaPropertyBuilder` Builder for `IdentifiableJsonSchemaProperty`.

Method Summary

Methods inherited from interface org.springframework.data.mongodb.core.schema.JsonSchemaObject
array, bool, date, getTypes, nil, number, object, of, of, string, timestamp, toDocument, untyped

- Method Detail
  - getIdentifier
```
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...).
    
    Returns:
    
    never null.
  - isRequired
```
default boolean isRequired()
```
    Returns:
    
    false by default.
    
    Since:
    
    2.2
  - untyped
```
static IdentifiableJsonSchemaProperty.UntypedJsonSchemaProperty untyped(String identifier)
```
    Creates a new IdentifiableJsonSchemaProperty.UntypedJsonSchemaProperty with given identifier without type.
    
    Parameters:
    
    identifier - the property name or patternProperty regex. Must not be null nor empty.
    
    Returns:
    
    new instance of IdentifiableJsonSchemaProperty.UntypedJsonSchemaProperty.
  - encrypted
```
static IdentifiableJsonSchemaProperty.EncryptedJsonSchemaProperty encrypted(JsonSchemaProperty property)
```
    Turns the given target property into an ecrypted one.
    
    Parameters:
    
    property - must not be null.
    
    Returns:
    
    new instance of IdentifiableJsonSchemaProperty.EncryptedJsonSchemaProperty.
    
    Since:
    
    2.2
  - string
```
static IdentifiableJsonSchemaProperty.StringJsonSchemaProperty string(String identifier)
```
    Creates a new IdentifiableJsonSchemaProperty.StringJsonSchemaProperty with given identifier of type : 'string'.
    
    Parameters:
    
    identifier - the property name or patternProperty regex. Must not be null nor empty.
    
    Returns:
    
    new instance of IdentifiableJsonSchemaProperty.StringJsonSchemaProperty.
  - object
```
static IdentifiableJsonSchemaProperty.ObjectJsonSchemaProperty object(String identifier)
```
    Creates a new IdentifiableJsonSchemaProperty.ObjectJsonSchemaProperty with given identifier of type : 'object'.
    
    Parameters:
    
    identifier - the property name or patternProperty regex. Must not be null nor empty.
    
    Returns:
    
    new instance of IdentifiableJsonSchemaProperty.ObjectJsonSchemaProperty.
  - objectId
```
static JsonSchemaProperty objectId(String identifier)
```
    Creates a new JsonSchemaProperty with given identifier of bsonType : 'objectId'.
    
    Parameters:
    
    identifier - the property name or patternProperty regex. Must not be null nor empty.
    
    Returns:
    
    new instance of JsonSchemaProperty.
    
    Since:
    
    2.2
  - number
```
static IdentifiableJsonSchemaProperty.NumericJsonSchemaProperty number(String identifier)
```
    Creates a new IdentifiableJsonSchemaProperty.NumericJsonSchemaProperty with given identifier of type : 'number'.
    
    Parameters:
    
    identifier - the property name or patternProperty regex. Must not be null nor empty.
    
    Returns:
    
    new instance of IdentifiableJsonSchemaProperty.NumericJsonSchemaProperty.
  - int32
```
static IdentifiableJsonSchemaProperty.NumericJsonSchemaProperty int32(String identifier)
```
    Creates a new IdentifiableJsonSchemaProperty.NumericJsonSchemaProperty with given identifier of bsonType : 'int'.
    
    Parameters:
    
    identifier - the property name or patternProperty regex. Must not be null nor empty.
    
    Returns:
    
    new instance of IdentifiableJsonSchemaProperty.NumericJsonSchemaProperty.
  - int64
```
static IdentifiableJsonSchemaProperty.NumericJsonSchemaProperty int64(String identifier)
```
    Creates a new IdentifiableJsonSchemaProperty.NumericJsonSchemaProperty with given identifier of bsonType : 'long'.
    
    Parameters:
    
    identifier - the property name or patternProperty regex. Must not be null nor empty.
    
    Returns:
    
    new instance of IdentifiableJsonSchemaProperty.NumericJsonSchemaProperty.
  - float64
```
static IdentifiableJsonSchemaProperty.NumericJsonSchemaProperty float64(String identifier)
```
    Creates a new IdentifiableJsonSchemaProperty.NumericJsonSchemaProperty with given identifier of bsonType : 'double'.
    
    Parameters:
    
    identifier - the property name or patternProperty regex. Must not be null nor empty.
    
    Returns:
    
    new instance of IdentifiableJsonSchemaProperty.NumericJsonSchemaProperty.
  - decimal128
```
static IdentifiableJsonSchemaProperty.NumericJsonSchemaProperty decimal128(String identifier)
```
    Creates a new IdentifiableJsonSchemaProperty.NumericJsonSchemaProperty with given identifier of bsonType : 'decimal128'.
    
    Parameters:
    
    identifier - the property name or patternProperty regex. Must not be null nor empty.
    
    Returns:
    
    new instance of IdentifiableJsonSchemaProperty.NumericJsonSchemaProperty.
  - array
```
static IdentifiableJsonSchemaProperty.ArrayJsonSchemaProperty array(String identifier)
```
    Creates a new IdentifiableJsonSchemaProperty.ArrayJsonSchemaProperty with given identifier of type : 'array'.
    
    Parameters:
    
    identifier - the property name or patternProperty regex. Must not be null nor empty.
    
    Returns:
    
    new instance of IdentifiableJsonSchemaProperty.ArrayJsonSchemaProperty.
  - bool
```
static IdentifiableJsonSchemaProperty.BooleanJsonSchemaProperty bool(String identifier)
```
    Creates a new IdentifiableJsonSchemaProperty.BooleanJsonSchemaProperty with given identifier of type : 'boolean'.
    
    Parameters:
    
    identifier - the property name or patternProperty regex. Must not be null nor empty.
    
    Returns:
    
    new instance of IdentifiableJsonSchemaProperty.BooleanJsonSchemaProperty.
  - nil
```
static IdentifiableJsonSchemaProperty.NullJsonSchemaProperty nil(String identifier)
```
    Creates a new IdentifiableJsonSchemaProperty.BooleanJsonSchemaProperty with given identifier of type : 'null'.
    
    Parameters:
    
    identifier - the property name or patternProperty regex. Must not be null nor empty.
    
    Returns:
    
    new instance of IdentifiableJsonSchemaProperty.NullJsonSchemaProperty.
  - date
```
static IdentifiableJsonSchemaProperty.DateJsonSchemaProperty date(String identifier)
```
    Creates a new IdentifiableJsonSchemaProperty.DateJsonSchemaProperty with given identifier of type : 'date'.
    
    Parameters:
    
    identifier - the property name or patternProperty regex. Must not be null nor empty.
    
    Returns:
    
    new instance of IdentifiableJsonSchemaProperty.DateJsonSchemaProperty.
  - timestamp
```
static IdentifiableJsonSchemaProperty.TimestampJsonSchemaProperty timestamp(String identifier)
```
    Creates a new IdentifiableJsonSchemaProperty.TimestampJsonSchemaProperty with given identifier of type : 'timestamp'.
    
    Parameters:
    
    identifier - the property name or patternProperty regex. Must not be null nor empty.
    
    Returns:
    
    new instance of IdentifiableJsonSchemaProperty.TimestampJsonSchemaProperty.
  - named
```
static JsonSchemaProperty.JsonSchemaPropertyBuilder named(String identifier)
```
    Obtain a builder to create a JsonSchemaProperty.
    
    Parameters:
    
    identifier -
    
    Returns:
  - required
```
static JsonSchemaProperty required(JsonSchemaProperty property)
```
    Turns the given JsonSchemaProperty into a required on.
    
    Parameters:
    
    property - must not be null.
    
    Returns:
    
    new instance of JsonSchemaProperty.
    
    Since:
    
    2.2

Modifier and Type	Method and Description
`static IdentifiableJsonSchemaProperty.ArrayJsonSchemaProperty`	`array(String identifier)` Creates a new `IdentifiableJsonSchemaProperty.ArrayJsonSchemaProperty` with given identifier of `type : 'array'`.
`static IdentifiableJsonSchemaProperty.BooleanJsonSchemaProperty`	`bool(String identifier)` Creates a new `IdentifiableJsonSchemaProperty.BooleanJsonSchemaProperty` with given identifier of `type : 'boolean'`.
`static IdentifiableJsonSchemaProperty.DateJsonSchemaProperty`	`date(String identifier)` Creates a new `IdentifiableJsonSchemaProperty.DateJsonSchemaProperty` with given identifier of `type : 'date'`.
`static IdentifiableJsonSchemaProperty.NumericJsonSchemaProperty`	`decimal128(String identifier)` Creates a new `IdentifiableJsonSchemaProperty.NumericJsonSchemaProperty` with given identifier of `bsonType : 'decimal128'`.
`static IdentifiableJsonSchemaProperty.EncryptedJsonSchemaProperty`	`encrypted(JsonSchemaProperty property)` Turns the given target property into an `ecrypted` one.
`static IdentifiableJsonSchemaProperty.NumericJsonSchemaProperty`	`float64(String identifier)` Creates a new `IdentifiableJsonSchemaProperty.NumericJsonSchemaProperty` with given identifier of `bsonType : 'double'`.
`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...)`.
`static IdentifiableJsonSchemaProperty.NumericJsonSchemaProperty`	`int32(String identifier)` Creates a new `IdentifiableJsonSchemaProperty.NumericJsonSchemaProperty` with given identifier of `bsonType : 'int'`.
`static IdentifiableJsonSchemaProperty.NumericJsonSchemaProperty`	`int64(String identifier)` Creates a new `IdentifiableJsonSchemaProperty.NumericJsonSchemaProperty` with given identifier of `bsonType : 'long'`.
`default boolean`	`isRequired()`
`static JsonSchemaProperty.JsonSchemaPropertyBuilder`	`named(String identifier)` Obtain a builder to create a `JsonSchemaProperty`.
`static IdentifiableJsonSchemaProperty.NullJsonSchemaProperty`	`nil(String identifier)` Creates a new `IdentifiableJsonSchemaProperty.BooleanJsonSchemaProperty` with given identifier of `type : 'null'`.
`static IdentifiableJsonSchemaProperty.NumericJsonSchemaProperty`	`number(String identifier)` Creates a new `IdentifiableJsonSchemaProperty.NumericJsonSchemaProperty` with given identifier of `type : 'number'`.
`static IdentifiableJsonSchemaProperty.ObjectJsonSchemaProperty`	`object(String identifier)` Creates a new `IdentifiableJsonSchemaProperty.ObjectJsonSchemaProperty` with given identifier of `type : 'object'`.
`static JsonSchemaProperty`	`objectId(String identifier)` Creates a new `JsonSchemaProperty` with given identifier of `bsonType : 'objectId'`.
`static JsonSchemaProperty`	`required(JsonSchemaProperty property)` Turns the given `JsonSchemaProperty` into a required on.
`static IdentifiableJsonSchemaProperty.StringJsonSchemaProperty`	`string(String identifier)` Creates a new `IdentifiableJsonSchemaProperty.StringJsonSchemaProperty` with given identifier of `type : 'string'`.
`static IdentifiableJsonSchemaProperty.TimestampJsonSchemaProperty`	`timestamp(String identifier)` Creates a new `IdentifiableJsonSchemaProperty.TimestampJsonSchemaProperty` with given identifier of `type : 'timestamp'`.
`static IdentifiableJsonSchemaProperty.UntypedJsonSchemaProperty`	`untyped(String identifier)` Creates a new `IdentifiableJsonSchemaProperty.UntypedJsonSchemaProperty` with given identifier without `type`.

Interface JsonSchemaProperty

Nested Class Summary

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

Method Summary

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

Method Detail

getIdentifier

isRequired

untyped

encrypted

string

object

objectId

number

int32

int64

float64

decimal128

array

bool

nil

date

timestamp

named

required