org.everit.json.schema

Class ArraySchema

java.lang.Object

org.everit.json.schema.Schema

org.everit.json.schema.ArraySchema

public class ArraySchema
extends Schema

Array schema validator.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ArraySchema.Builder Builder class for ArraySchema.

Field Summary

Fields inherited from class org.everit.json.schema.Schema

schemaLocation

Constructor Summary

Constructors

Constructor and Description
ArraySchema(ArraySchema.Builder builder) Constructor.

Method Summary

Modifier and Type	Method and Description
static ArraySchema.Builder	builder()
protected boolean	canEqual(Object other) Since we add state in subclasses, but want those subclasses to be non final, this allows us to have equals methods that satisfy the equals contract.
boolean	definesProperty(String field) Determines if this Schema instance defines any restrictions for the object property denoted by field.
boolean	equals(Object o)
Schema	getAllItemSchema()
Schema	getContainedItemSchema()
List<Schema>	getItemSchemas()
Integer	getMaxItems()
Integer	getMinItems()
Schema	getSchemaOfAdditionalItems()
int	hashCode()
boolean	needsUniqueItems()
boolean	permitsAdditionalItems()
boolean	requiresArray()

Methods inherited from class org.everit.json.schema.Schema

describeTo, failure, failure, getDefaultValue, getDescription, getId, getLocation, getSchemaLocation, getTitle, getUnprocessedProperties, hasDefaultValue, isNullable, isReadOnly, isWriteOnly, toString, validate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ArraySchema

public ArraySchema(ArraySchema.Builder builder)

Constructor.

Parameters:

builder - contains validation criteria.

Method Detail

builder

public static ArraySchema.Builder builder()

getAllItemSchema

public Schema getAllItemSchema()

getItemSchemas

public List<Schema> getItemSchemas()

getMaxItems

public Integer getMaxItems()

getMinItems

public Integer getMinItems()

getSchemaOfAdditionalItems

public Schema getSchemaOfAdditionalItems()

getContainedItemSchema

public Schema getContainedItemSchema()

needsUniqueItems

public boolean needsUniqueItems()

permitsAdditionalItems

public boolean permitsAdditionalItems()

requiresArray

public boolean requiresArray()

equals

public boolean equals(Object o)

Overrides:

equals in class Schema

definesProperty

public boolean definesProperty(String field)

Description copied from class: Schema

Determines if this Schema instance defines any restrictions for the object property denoted by field. The field should be a JSON pointer, denoting the property to be queried.

For example the field "#/rectangle/a" is defined by the following schema:

 
 objectWithSchemaRectangleDep" : {
   "type" : "object",
   "dependencies" : {
       "d" : {
           "type" : "object",
           "properties" : {
               "rectangle" : {
                  "$ref" : "#/definitions/Rectangle"
               },
               "list": {
                   "type": "array",
                   "items": {
                       "properties": {
                          "prop": {}
                       }
                   },
                   "minItems": 2,
                   "maxItems: 3
               }
           }
       }
   },
   "definitions" : {
       "size" : {
           "type" : "number",
           "minimum" : 0
       },
       "Rectangle" : {
           "type" : "object",
           "properties" : {
               "a" : {"$ref" : "#/definitions/size"},
               "b" : {"$ref" : "#/definitions/size"}
           }
       }
    }
 }
 
 

You can also check if a subschema of an array defines a property. In that case, to traverse the array, you can either use an integer array index, or the "all" or "any" meta-indexes. For example, in the above schema

• definesProperty("#/list/any/prop") returns true
• definesProperty("#/list/all/prop") returns true
• definesProperty("#/list/1/prop") returns true
• definesProperty("#/list/1/nonexistent") returns false (the property is not present in the subschema)
• definesProperty("#/list/8/prop") returns false (the "list" does not define property 8, since "maxItems" is 3)

The default implementation of this method always returns false.

Overrides:

definesProperty in class Schema

Parameters:

field - should be a JSON pointer in its string representation.

Returns:

true if the propertty denoted by field is defined by this schema instance

canEqual

protected boolean canEqual(Object other)

Description copied from class: Schema

Since we add state in subclasses, but want those subclasses to be non final, this allows us to have equals methods that satisfy the equals contract.

http://www.artima.com/lejava/articles/equality.html

Overrides:

canEqual in class Schema

Parameters:

other - the subject of comparison

Returns:

true if this can be equal to other

hashCode

public int hashCode()

Overrides:

hashCode in class Schema