TypedJsonSchemaObject (Spring Data MongoDB 2.1.0.RELEASE API)

java.lang.Object
- org.springframework.data.mongodb.core.schema.UntypedJsonSchemaObject
- - org.springframework.data.mongodb.core.schema.TypedJsonSchemaObject

All Implemented Interfaces:

JsonSchemaObject

Direct Known Subclasses:

TypedJsonSchemaObject.ArrayJsonSchemaObject, TypedJsonSchemaObject.BooleanJsonSchemaObject, TypedJsonSchemaObject.NumericJsonSchemaObject, TypedJsonSchemaObject.ObjectJsonSchemaObject, TypedJsonSchemaObject.StringJsonSchemaObject
```
public class TypedJsonSchemaObject
extends UntypedJsonSchemaObject
```
A JsonSchemaObject of a given JsonSchemaObject.Type.

Since:

2.1

Author:

Christoph Strobl, Mark Paluch

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`TypedJsonSchemaObject.ArrayJsonSchemaObject` `JsonSchemaObject` implementation of `type : 'array'` schema elements.
`static class`	`TypedJsonSchemaObject.BooleanJsonSchemaObject` `JsonSchemaObject` implementation of `type : 'boolean'` schema elements.
`static class`	`TypedJsonSchemaObject.NumericJsonSchemaObject` `JsonSchemaObject` implementation of `type : 'number'`, `bsonType : 'int'`, `bsonType : 'long'`, `bsonType : 'double'` and `bsonType : 'decimal128'` schema elements.
`static class`	`TypedJsonSchemaObject.ObjectJsonSchemaObject` `JsonSchemaObject` implementation of `type : 'object'` schema elements.
`static class`	`TypedJsonSchemaObject.StringJsonSchemaObject` `JsonSchemaObject` implementation of `type : 'string'` schema elements.

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

Field Summary

Fields
Modifier and Type Field and Description

protected Set<JsonSchemaObject.Type> types
- Fields inherited from class org.springframework.data.mongodb.core.schema.UntypedJsonSchemaObject
  description, generateDescription, restrictions

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TypedJsonSchemaObject`	`allOf(Collection<JsonSchemaObject> allOf)` The field value must match all specified schemas.
`TypedJsonSchemaObject`	`anyOf(Collection<JsonSchemaObject> anyOf)` The field value must match at least one of the specified schemas.
`TypedJsonSchemaObject`	`description(String description)` Set the description.
`TypedJsonSchemaObject`	`generatedDescription()` Auto generate the description if not explicitly set.
`protected String`	`generateDescription()` Customization hook for creating description out of defined values.
`Set<JsonSchemaObject.Type>`	`getTypes()` Get the set of types defined for this schema element.
`TypedJsonSchemaObject`	`notMatch(JsonSchemaObject notMatch)` The field value must not match the specified schemas.
`static TypedJsonSchemaObject`	`of(JsonSchemaObject.Type... types)` Creates new `TypedJsonSchemaObject` of given types.
`TypedJsonSchemaObject`	`oneOf(Collection<JsonSchemaObject> oneOf)` The field value must match exactly one of the specified schemas.
`TypedJsonSchemaObject`	`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.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

- Field Detail
  - types
```
protected final Set<JsonSchemaObject.Type> types
```
- Method Detail
  - of
```
public static TypedJsonSchemaObject of(JsonSchemaObject.Type... types)
```
    Creates new TypedJsonSchemaObject of given types.
    
    Parameters:
    
    types - must not be null.
    
    Returns:
  - 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
    
    Overrides:
    
    getTypes in class UntypedJsonSchemaObject
    
    Returns:
    
    never null.
  - description
```
public TypedJsonSchemaObject description(String description)
```
    Set the description.
    
    Overrides:
    
    description in class UntypedJsonSchemaObject
    
    Parameters:
    
    description - must not be null.
    
    Returns:
    
    new instance of TypedJsonSchemaObject.
  - generatedDescription
```
public TypedJsonSchemaObject generatedDescription()
```
    Auto generate the description if not explicitly set.
    
    Overrides:
    
    generatedDescription in class UntypedJsonSchemaObject
    
    Parameters:
    
    description - must not be null.
    
    Returns:
    
    new instance of TypedJsonSchemaObject.
  - possibleValues
```
public TypedJsonSchemaObject possibleValues(Collection<? extends Object> possibleValues)
```
    enumerates all possible values of the field.
    
    Overrides:
    
    possibleValues in class UntypedJsonSchemaObject
    
    Parameters:
    
    possibleValues - must not be null.
    
    Returns:
    
    new instance of TypedJsonSchemaObject.
  - allOf
```
public TypedJsonSchemaObject allOf(Collection<JsonSchemaObject> allOf)
```
    The field value must match all specified schemas.
    
    Overrides:
    
    allOf in class UntypedJsonSchemaObject
    
    Parameters:
    
    allOf - must not be null.
    
    Returns:
    
    new instance of TypedJsonSchemaObject.
  - anyOf
```
public TypedJsonSchemaObject anyOf(Collection<JsonSchemaObject> anyOf)
```
    The field value must match at least one of the specified schemas.
    
    Overrides:
    
    anyOf in class UntypedJsonSchemaObject
    
    Parameters:
    
    anyOf - must not be null.
    
    Returns:
    
    new instance of TypedJsonSchemaObject.
  - oneOf
```
public TypedJsonSchemaObject oneOf(Collection<JsonSchemaObject> oneOf)
```
    The field value must match exactly one of the specified schemas.
    
    Overrides:
    
    oneOf in class UntypedJsonSchemaObject
    
    Parameters:
    
    oneOf - must not be null.
    
    Returns:
    
    new instance of TypedJsonSchemaObject.
  - notMatch
```
public TypedJsonSchemaObject notMatch(JsonSchemaObject notMatch)
```
    The field value must not match the specified schemas.
    
    Overrides:
    
    notMatch in class UntypedJsonSchemaObject
    
    Parameters:
    
    oneOf - must not be null.
    
    Returns:
    
    new instance of TypedJsonSchemaObject.
  - toDocument
```
public org.bson.Document toDocument()
```
    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 UntypedJsonSchemaObject
    
    Returns:
    
    never null.
  - generateDescription
```
@Nullable
protected String generateDescription()
```
    Customization hook for creating description out of defined values.
    Called by toDocument() when no explicit description(java.lang.String) is set.
    
    Overrides:
    
    generateDescription in class UntypedJsonSchemaObject
    
    Returns:
    
    can be null.

Class TypedJsonSchemaObject

Nested Class Summary

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

Field Summary

Fields inherited from class org.springframework.data.mongodb.core.schema.UntypedJsonSchemaObject

Method Summary

Methods inherited from class org.springframework.data.mongodb.core.schema.UntypedJsonSchemaObject

Methods inherited from class java.lang.Object

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

Field Detail

types

Method Detail

of

getTypes

description

generatedDescription

possibleValues

allOf

anyOf

oneOf

notMatch

toDocument

generateDescription