org.everit.json.schema

Class ObjectSchema

java.lang.Object

org.everit.json.schema.Schema

org.everit.json.schema.ObjectSchema

public class ObjectSchema
extends Schema

Object schema validator.

Nested Class Summary

Nested Classes

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

Field Summary

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

schemaLocation

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static ObjectSchema.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)
Integer	getMaxProperties()
Integer	getMinProperties()
Map<Pattern,Schema>	getPatternProperties() Deprecated.
Map<String,Set<String>>	getPropertyDependencies()
Schema	getPropertyNameSchema()
Map<String,Schema>	getPropertySchemas()
List<String>	getRequiredProperties()
Map<String,Schema>	getSchemaDependencies()
Schema	getSchemaOfAdditionalProperties()
int	hashCode()
boolean	permitsAdditionalProperties()
boolean	requiresObject()

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

ObjectSchema

public ObjectSchema(ObjectSchema.Builder builder)

Constructor.

Parameters:

builder - the builder object containing validation criteria

Method Detail

builder

public static ObjectSchema.Builder builder()

getMaxProperties

public Integer getMaxProperties()

getMinProperties

public Integer getMinProperties()

getPatternProperties

@Deprecated
public Map<Pattern,Schema> getPatternProperties()

Deprecated.

getPropertyDependencies

public Map<String,Set<String>> getPropertyDependencies()

getPropertySchemas

public Map<String,Schema> getPropertySchemas()

getRequiredProperties

public List<String> getRequiredProperties()

getSchemaDependencies

public Map<String,Schema> getSchemaDependencies()

getSchemaOfAdditionalProperties

public Schema getSchemaOfAdditionalProperties()

getPropertyNameSchema

public Schema getPropertyNameSchema()

permitsAdditionalProperties

public boolean permitsAdditionalProperties()

requiresObject

public boolean requiresObject()

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

equals

public boolean equals(Object o)

Overrides:

equals in class Schema

hashCode

public int hashCode()

Overrides:

hashCode in class Schema

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