TypedJsonSchemaObject.ArrayJsonSchemaObject (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
  - - org.springframework.data.mongodb.core.schema.TypedJsonSchemaObject.ArrayJsonSchemaObject

All Implemented Interfaces:

JsonSchemaObject

Enclosing class:

TypedJsonSchemaObject
```
public static class TypedJsonSchemaObject.ArrayJsonSchemaObject
extends TypedJsonSchemaObject
```
JsonSchemaObject implementation of type : 'array' schema elements.
Provides programmatic access to schema specifics like range, minItems, maxItems,... via a fluent API producing immutable schema objects.

Since:

2.1

Author:

Christoph Strobl, Mark Paluch

Nested Class Summary
- Nested classes/interfaces inherited from class org.springframework.data.mongodb.core.schema.TypedJsonSchemaObject
  TypedJsonSchemaObject.ArrayJsonSchemaObject, TypedJsonSchemaObject.BooleanJsonSchemaObject, TypedJsonSchemaObject.NumericJsonSchemaObject, TypedJsonSchemaObject.ObjectJsonSchemaObject, TypedJsonSchemaObject.StringJsonSchemaObject
- Nested classes/interfaces inherited from interface org.springframework.data.mongodb.core.schema.JsonSchemaObject
  JsonSchemaObject.Type

Field Summary
- Fields inherited from class org.springframework.data.mongodb.core.schema.TypedJsonSchemaObject
  types
- Fields inherited from class org.springframework.data.mongodb.core.schema.UntypedJsonSchemaObject
  description, generateDescription, restrictions

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TypedJsonSchemaObject.ArrayJsonSchemaObject`	`additionalItems(boolean additionalItemsAllowed)` If set to false, no additional items besides `items(Collection)` are allowed.
`TypedJsonSchemaObject.ArrayJsonSchemaObject`	`allOf(Collection<JsonSchemaObject> allOf)` The field value must match all specified schemas.
`TypedJsonSchemaObject.ArrayJsonSchemaObject`	`anyOf(Collection<JsonSchemaObject> anyOf)` The field value must match at least one of the specified schemas.
`TypedJsonSchemaObject.ArrayJsonSchemaObject`	`description(String description)` Set the description.
`TypedJsonSchemaObject.ArrayJsonSchemaObject`	`generatedDescription()` Auto generate the description if not explicitly set.
`protected String`	`generateDescription()` Customization hook for creating description out of defined values.
`TypedJsonSchemaObject.ArrayJsonSchemaObject`	`items(Collection<JsonSchemaObject> items)` Define the `items` allowed in the array.
`TypedJsonSchemaObject.ArrayJsonSchemaObject`	`maxItems(int count)` Define the maxItems.
`TypedJsonSchemaObject.ArrayJsonSchemaObject`	`minItems(int count)` Define the maxItems.
`TypedJsonSchemaObject.ArrayJsonSchemaObject`	`notMatch(JsonSchemaObject notMatch)` The field value must not match the specified schemas.
`TypedJsonSchemaObject.ArrayJsonSchemaObject`	`oneOf(Collection<JsonSchemaObject> oneOf)` The field value must match exactly one of the specified schemas.
`TypedJsonSchemaObject.ArrayJsonSchemaObject`	`possibleValues(Collection<? extends Object> possibleValues)` enumerates all possible values of the field.
`TypedJsonSchemaObject.ArrayJsonSchemaObject`	`range(Range<Integer> range)` Define the minItems and maxItems via the given `Range`.
`org.bson.Document`	`toDocument()` Create the JSON schema complying `Document` representation.
`TypedJsonSchemaObject.ArrayJsonSchemaObject`	`uniqueItems(boolean uniqueItems)` Define the whether the array must contain unique items.

Methods inherited from class org.springframework.data.mongodb.core.schema.TypedJsonSchemaObject
getTypes, of

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

- Method Detail
  - uniqueItems
```
public TypedJsonSchemaObject.ArrayJsonSchemaObject uniqueItems(boolean uniqueItems)
```
    Define the whether the array must contain unique items.
    
    Parameters:
    
    uniqueItems -
    
    Returns:
    
    new instance of TypedJsonSchemaObject.ArrayJsonSchemaObject.
  - range
```
public TypedJsonSchemaObject.ArrayJsonSchemaObject range(Range<Integer> range)
```
    Define the minItems and maxItems via the given Range.
    In-/Exclusions via range bounds are not taken into account.
    
    Parameters:
    
    range - must not be null. Consider Range.unbounded() instead.
    
    Returns:
    
    new instance of TypedJsonSchemaObject.ArrayJsonSchemaObject.
  - minItems
```
public TypedJsonSchemaObject.ArrayJsonSchemaObject minItems(int count)
```
    Define the maxItems.
    
    Parameters:
    
    count - the allowed minimal number of array items.
    
    Returns:
    
    new instance of TypedJsonSchemaObject.ArrayJsonSchemaObject.
  - maxItems
```
public TypedJsonSchemaObject.ArrayJsonSchemaObject maxItems(int count)
```
    Define the maxItems.
    
    Parameters:
    
    count - the allowed maximal number of array items.
    
    Returns:
    
    new instance of TypedJsonSchemaObject.ArrayJsonSchemaObject.
  - items
```
public TypedJsonSchemaObject.ArrayJsonSchemaObject items(Collection<JsonSchemaObject> items)
```
    Define the items allowed in the array.
    
    Parameters:
    
    items - the allowed items in the array.
    
    Returns:
    
    new instance of TypedJsonSchemaObject.ArrayJsonSchemaObject.
  - additionalItems
```
public TypedJsonSchemaObject.ArrayJsonSchemaObject additionalItems(boolean additionalItemsAllowed)
```
    If set to false, no additional items besides items(Collection) are allowed.
    
    Parameters:
    
    additionalItemsAllowed - true to allow additional items in the array, false otherwise.
    
    Returns:
    
    new instance of TypedJsonSchemaObject.ArrayJsonSchemaObject.
  - possibleValues
```
public TypedJsonSchemaObject.ArrayJsonSchemaObject possibleValues(Collection<? extends Object> possibleValues)
```
    Description copied from class: TypedJsonSchemaObject
    
    enumerates all possible values of the field.
    
    Overrides:
    
    possibleValues in class TypedJsonSchemaObject
    
    Parameters:
    
    possibleValues - must not be null.
    
    Returns:
    
    new instance of TypedJsonSchemaObject.
  - allOf
```
public TypedJsonSchemaObject.ArrayJsonSchemaObject allOf(Collection<JsonSchemaObject> allOf)
```
    Description copied from class: TypedJsonSchemaObject
    
    The field value must match all specified schemas.
    
    Overrides:
    
    allOf in class TypedJsonSchemaObject
    
    Parameters:
    
    allOf - must not be null.
    
    Returns:
    
    new instance of TypedJsonSchemaObject.
  - anyOf
```
public TypedJsonSchemaObject.ArrayJsonSchemaObject anyOf(Collection<JsonSchemaObject> anyOf)
```
    Description copied from class: TypedJsonSchemaObject
    
    The field value must match at least one of the specified schemas.
    
    Overrides:
    
    anyOf in class TypedJsonSchemaObject
    
    Parameters:
    
    anyOf - must not be null.
    
    Returns:
    
    new instance of TypedJsonSchemaObject.
  - oneOf
```
public TypedJsonSchemaObject.ArrayJsonSchemaObject oneOf(Collection<JsonSchemaObject> oneOf)
```
    Description copied from class: TypedJsonSchemaObject
    
    The field value must match exactly one of the specified schemas.
    
    Overrides:
    
    oneOf in class TypedJsonSchemaObject
    
    Parameters:
    
    oneOf - must not be null.
    
    Returns:
    
    new instance of TypedJsonSchemaObject.
  - notMatch
```
public TypedJsonSchemaObject.ArrayJsonSchemaObject notMatch(JsonSchemaObject notMatch)
```
    Description copied from class: TypedJsonSchemaObject
    
    The field value must not match the specified schemas.
    
    Overrides:
    
    notMatch in class TypedJsonSchemaObject
    
    Returns:
    
    new instance of TypedJsonSchemaObject.
  - description
```
public TypedJsonSchemaObject.ArrayJsonSchemaObject description(String description)
```
    Description copied from class: TypedJsonSchemaObject
    
    Set the description.
    
    Overrides:
    
    description in class TypedJsonSchemaObject
    
    Parameters:
    
    description - must not be null.
    
    Returns:
    
    new instance of TypedJsonSchemaObject.
  - generatedDescription
```
public TypedJsonSchemaObject.ArrayJsonSchemaObject generatedDescription()
```
    Description copied from class: TypedJsonSchemaObject
    
    Auto generate the description if not explicitly set.
    
    Overrides:
    
    generatedDescription in class TypedJsonSchemaObject
    
    Returns:
    
    new instance of TypedJsonSchemaObject.
  - toDocument
```
public org.bson.Document toDocument()
```
    Description copied from class: TypedJsonSchemaObject
    
    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 TypedJsonSchemaObject
    
    Returns:
    
    never null.
  - generateDescription
```
protected String generateDescription()
```
    Description copied from class: TypedJsonSchemaObject
    
    Customization hook for creating description out of defined values.
    Called by TypedJsonSchemaObject.toDocument() when no explicit TypedJsonSchemaObject.description(java.lang.String) is set.
    
    Overrides:
    
    generateDescription in class TypedJsonSchemaObject
    
    Returns:
    
    can be null.

Class TypedJsonSchemaObject.ArrayJsonSchemaObject

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.data.mongodb.core.schema.TypedJsonSchemaObject

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.TypedJsonSchemaObject

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

Method Summary

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

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

Method Detail

uniqueItems

range

minItems

maxItems

items

additionalItems

possibleValues

allOf

anyOf

oneOf

notMatch

description

generatedDescription

toDocument

generateDescription