org.everit.json.schema

Class Schema

java.lang.Object

org.everit.json.schema.Schema

Direct Known Subclasses:

ArraySchema, BooleanSchema, CombinedSchema, EmptySchema, EnumSchema, NotSchema, NullSchema, NumberSchema, ObjectSchema, ReferenceSchema, StringSchema

public abstract class Schema
extends Object

Superclass of all other schema validator classes of this package.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Schema.Builder<S extends Schema> Abstract builder class for the builder classes of Schema subclasses.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Schema(Schema.Builder<?> builder) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	definesProperty(String field) Determines if this Schema instance defines any restrictions for the object property denoted by field.
boolean	equals(Object obj)
String	getDescription()
String	getId()
String	getTitle()
int	hashCode()
abstract void	validate(Object subject) Performs the schema validation.

Methods inherited from class java.lang.Object

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

Constructor Detail

Schema

protected Schema(Schema.Builder<?> builder)

Constructor.

Parameters:

builder - the builder containing the optional title, description and id attributes of the schema

Method Detail

validate

public abstract void validate(Object subject)

Performs the schema validation.

Parameters:

subject - the object to be validated

Throws:

ValidationException - if the subject is invalid against this schema.

definesProperty

public boolean definesProperty(String field)

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.

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

@Generated(value="eclipse")
public boolean equals(Object obj)

Overrides:

equals in class Object

getTitle

public String getTitle()

getDescription

public String getDescription()

getId

public String getId()