Package org.everit.json.schema

Class CombinedSchema

java.lang.Object

org.everit.json.schema.Schema

org.everit.json.schema.CombinedSchema

public class CombinedSchema
extends Schema

Validator for allOf, oneOf, anyOf schemas.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CombinedSchema.Builder	Builder class for CombinedSchema.
static interface	CombinedSchema.ValidationCriterion	Validation criterion.

Field Summary

Fields

Modifier and Type	Field	Description
static CombinedSchema.ValidationCriterion	ALL_CRITERION	Validation criterion for allOf schemas.
static CombinedSchema.ValidationCriterion	ANY_CRITERION	Validation criterion for anyOf schemas.
static CombinedSchema.ValidationCriterion	ONE_CRITERION	Validation criterion for oneOf schemas.

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

schemaLocation

Constructor Summary

Constructors

Constructor	Description
CombinedSchema(CombinedSchema.Builder builder)	Constructor.

Method Summary

Modifier and Type	Method	Description
static CombinedSchema.Builder	allOf(Collection<Schema> schemas)
static CombinedSchema.Builder	anyOf(Collection<Schema> schemas)
static CombinedSchema.Builder	builder()
static CombinedSchema.Builder	builder(Collection<Schema> subschemas)
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)
CombinedSchema.ValidationCriterion	getCriterion()
Collection<Schema>	getSubschemas()
int	hashCode()
static CombinedSchema.Builder	oneOf(Collection<Schema> schemas)

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

Field Detail

ALL_CRITERION

public static final CombinedSchema.ValidationCriterion ALL_CRITERION

Validation criterion for allOf schemas.

ANY_CRITERION

public static final CombinedSchema.ValidationCriterion ANY_CRITERION

Validation criterion for anyOf schemas.

ONE_CRITERION

public static final CombinedSchema.ValidationCriterion ONE_CRITERION

Validation criterion for oneOf schemas.

Constructor Detail

CombinedSchema

public CombinedSchema(CombinedSchema.Builder builder)

Constructor.

Parameters:

builder - the builder containing the validation criterion and the subschemas to be checked

Method Detail

allOf

public static CombinedSchema.Builder allOf(Collection<Schema> schemas)

anyOf

public static CombinedSchema.Builder anyOf(Collection<Schema> schemas)

builder

public static CombinedSchema.Builder builder()

builder

public static CombinedSchema.Builder builder(Collection<Schema> subschemas)

oneOf

public static CombinedSchema.Builder oneOf(Collection<Schema> schemas)

getCriterion

public CombinedSchema.ValidationCriterion getCriterion()

getSubschemas

public Collection<Schema> getSubschemas()

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" }
           }
       }
   },
   "definitions" : {
       "size" : {
           "type" : "number",
           "minimum" : 0
       },
       "Rectangle" : {
           "type" : "object",
           "properties" : {
               "a" : {"$ref" : "#/definitions/size"},
               "b" : {"$ref" : "#/definitions/size"}
           }
       }
    }
 }
 
 

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