MongoJsonSchema (Spring Data MongoDB 2.1.0.RELEASE API)

public interface MongoJsonSchema

Interface defining MongoDB-specific JSON schema object. New objects can be built with builder(), for example:

 MongoJsonSchema schema = MongoJsonSchema.builder().required("firstname", "lastname")
                .properties(string("firstname").possibleValues("luke", "han"),
                                object("address").properties(string("postCode").minLength(4).maxLength(5))

                ).build();

resulting in the following schema:

  {
  "type": "object",
  "required": [ "firstname", "lastname" ],
  "properties": {
    "firstname": {
      "type": "string", "enum": [ "luke", "han" ],
    },
    "address": {
      "type": "object",
      "properties": {
        "postCode": { "type": "string", "minLength": 4, "maxLength": 5 }
      }
    }
  }
}

Since:: 2.1
Author:: Christoph Strobl, Mark Paluch
See Also:: UntypedJsonSchemaObject, TypedJsonSchemaObject

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`MongoJsonSchema.MongoJsonSchemaBuilder` `MongoJsonSchema.MongoJsonSchemaBuilder` provides a fluent API for defining a `MongoJsonSchema`.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static MongoJsonSchema.MongoJsonSchemaBuilder`	`builder()` Obtain a new `MongoJsonSchema.MongoJsonSchemaBuilder` to fluently define the schema.
`static MongoJsonSchema`	`of(org.bson.Document document)` Create a new `MongoJsonSchema` for a given root `Document` containing the schema definition.
`static MongoJsonSchema`	`of(JsonSchemaObject root)` Create a new `MongoJsonSchema` for a given root object.
`org.bson.Document`	`toDocument()` Create the `Document` containing the specified `$jsonSchema`.

- Method Detail
  - toDocument
```
org.bson.Document toDocument()
```
    Create the Document containing the specified $jsonSchema.
    Property and field names need to be mapped to the domain type ones by running the Document through a JsonSchemaMapper to apply field name customization.
    
    Returns:
    
    never null.
  - of
```
static MongoJsonSchema of(JsonSchemaObject root)
```
    Create a new MongoJsonSchema for a given root object.
    
    Parameters:
    
    root - must not be null.
    
    Returns:
  - of
```
static MongoJsonSchema of(org.bson.Document document)
```
    Create a new MongoJsonSchema for a given root Document containing the schema definition.
    
    Parameters:
    
    document - must not be null.
    
    Returns:
  - builder
```
static MongoJsonSchema.MongoJsonSchemaBuilder builder()
```
    Obtain a new MongoJsonSchema.MongoJsonSchemaBuilder to fluently define the schema.
    
    Returns:
    
    new instance of MongoJsonSchema.MongoJsonSchemaBuilder.

Interface MongoJsonSchema

Nested Class Summary

Method Summary

Method Detail

toDocument

of

of

builder