JSONSchema (JSON Schema tools 2.0 API)

java.lang.Object
- be.ac.umons.jsonschematools.JSONSchema

```
public final class JSONSchema
extends Object
```
A JSON schema stores the constraints a JSON document must satisfy to be valid. This class implements tools to manipulate a JSON schema:
- Get the types allowed for the current schema. See Type.
- Get the value associated to a key.
- Get a sub-schema.
- Merge multiple sub-schemas into a single schema, with all the constraints. See the non-API documentation for more information on merging the constraints given by multiples instances of a key.
- Automatically follow $ref when encountered.
Author:

Gaëtan Staquet

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`depth()` Computes the depth of the schema, i.e., the maximal number of nested objects.
`JSONSchema`	`dropAllOfAnyOfOneOfAndNot()` Returns a copy of this schema without the sub-schemas for `allOf`, `anyOf`, `oneOf`, and `not`.
`JSONSchema`	`getAdditionalProperties()` Returns the schema describing the additional properties of this schema.
`Set<String>`	`getAllKeysDefinedInSchema()` Retrieves all the keys present in this schema.
`JSONSchema`	`getAllOf()` Gets a single schema obtained by merging together all the sub-schemas in the `allOf` array.
`List<Type>`	`getAllowedTypes()` Gets all the types that are allowed in this schema.
`List<JSONSchema>`	`getAnyOf()` Gets a list containing one schema by element in the `anyOf` array.
`boolean`	`getBoolean(String key)`
`boolean`	`getBooleanOr(String key, boolean defaultValue)`
`Object`	`getConstValue()` Returns the const value defined in this schema.
`<T> T`	`getConstValueIfType(Class<T> type)` Returns the const value defined in this schema, if the value's type matches the provided type.
`double`	`getDouble(String key)`
`double`	`getDoubleOr(String key, double defaultValue)`
`Set<Object>`	`getForbiddenValues()` Gets all the values that are forbidden by this schema.
`<T> Set<T>`	`getForbiddenValuesFilteredByType(Class<T> type)` Gets all the values of the given type that are forbidden by this schema.
`int`	`getInt(String key)`
`int`	`getIntOr(String key, int defaultValue)`
`List<JSONSchema>`	`getItemsArray()` Gets the sub-schemas for the items in an array.
`Map<String,JSONSchema>`	`getNonRequiredProperties()` Gets the pairs key-value that are not required by this schema.
`List<JSONSchema>`	`getNot()` Gets a list of sub-schemas, after propagating the `not` inside each sub-schema.
`Number`	`getNumber(String key)`
`Number`	`getNumberOr(String key, Number defaultValue)`
`List<JSONSchema>`	`getOneOf()` Gets a list containing one possible combination of the elements in the `oneOf` array, by applying the XOR operation.
`JSONSchema`	`getRawNot()` Get the contents of the key `not`, without any modifications.
`Map<String,JSONSchema>`	`getRequiredProperties()` Gets the pairs key-value that are required by this schema.
`Set<String>`	`getRequiredPropertiesKeys()` Gets the keys that are required in this schema's properties.
`JSONSchemaStore`	`getStore()` Returns the `JSONSchemaStore` holding this schema.
`String`	`getString(String key)`
`String`	`getStringOr(String key, String defaultValue)`
`JSONSchema`	`getSubSchema(String key)` Gets the sub-schema for the key `key`.
`JSONSchema`	`getSubSchemaProperties(String key)` Gets the sub-schema for the property `key`.
`boolean`	`isArray()` Returns true if this schema allows the type ARRAY.
`boolean`	`isBoolean()` Returns true if this schema allows the type BOOLEAN.
`boolean`	`isEnum()` Returns true if this schema allows the type ENUM.
`boolean`	`isInteger()` Returns true if this schema allows the type INTEGER.
`boolean`	`isNull()` Returns true if this schema allows the type NULL.
`boolean`	`isNumber()` Returns true if this schema allows the type NUMBER.
`boolean`	`isObject()` Returns true if this schema allows the type OBJECT.
`boolean`	`isString()` Returns true if this schema allows the type STRING.
`JSONSchema`	`merge(JSONSchema other)` Merge this schema with an other schema.
`boolean`	`needsFurtherUnfolding()` Checks whether there are still some constraints in some sub-schemas that must be merged with the whole schema.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - depth
```
public int depth()
          throws JSONSchemaException
```
    Computes the depth of the schema, i.e., the maximal number of nested objects. If the schema is recursive, the depth is infinite and this function does not return.
    
    Returns:
    
    The depth of the schema
    
    Throws:
    
    JSONSchemaException
  - getAdditionalProperties
```
public JSONSchema getAdditionalProperties()
                                   throws JSONSchemaException
```
    Returns the schema describing the additional properties of this schema. If this schema does not describe an object, the returned schema is always false.
    
    Returns:
    
    The schema describing the additional properties
    
    Throws:
    
    JSONSchemaException
  - getAllKeysDefinedInSchema
```
public Set<String> getAllKeysDefinedInSchema()
                                      throws JSONSchemaException
```
    Retrieves all the keys present in this schema. If the schema contains a sub-schema (due to properties, for instance), the answer will contain the keys from the sub-schema.
    
    Returns:
    
    A set containing all the keys defined in this schema.
    
    Throws:
    
    JSONSchemaException
  - getAllowedTypes
```
public List<Type> getAllowedTypes()
```
    Gets all the types that are allowed in this schema.
    
    Returns:
    
    A set containing all allowed types.
  - getForbiddenValues
```
public Set<Object> getForbiddenValues()
```
    Gets all the values that are forbidden by this schema. For instance, the constraint "not": {"const": 5} imposes that 5 is a forbidden value.
    
    Returns:
    
    A set with the forbidden values.
  - getForbiddenValuesFilteredByType
```
public <T> Set<T> getForbiddenValuesFilteredByType(Class<T> type)
```
    Gets all the values of the given type that are forbidden by this schema. This is equivalent to calling getForbiddenValues and only keeping the values with the correct type.
    
    Type Parameters:
    
    T - The type
    
    Parameters:
    
    type - A class instance for T
    
    Returns:
    
    A set with the filtered forbidden values.
  - getConstValue
```
public Object getConstValue()
```
    Returns the const value defined in this schema. If the const value is not defined, returns null.
    
    Returns:
    
    The const value, or null
  - getConstValueIfType
```
public <T> T getConstValueIfType(Class<T> type)
```
    Returns the const value defined in this schema, if the value's type matches the provided type. If the const value is not defined or is not an instance of the provided type, returns null.
    
    Type Parameters:
    
    T - The required type
    
    Parameters:
    
    type - The required class
    
    Returns:
    
    The const value, or null
  - isEnum
```
public boolean isEnum()
```
    Returns true if this schema allows the type ENUM.
    
    Returns:
    
    True if this schema allows the type ENUM.
  - isObject
```
public boolean isObject()
```
    Returns true if this schema allows the type OBJECT.
    
    Returns:
    
    True if this schema allows the type OBJECT.
  - isArray
```
public boolean isArray()
```
    Returns true if this schema allows the type ARRAY.
    
    Returns:
    
    True if this schema allows the type ARRAY.
  - isInteger
```
public boolean isInteger()
```
    Returns true if this schema allows the type INTEGER.
    
    Returns:
    
    True if this schema allows the type INTEGER.
  - isNumber
```
public boolean isNumber()
```
    Returns true if this schema allows the type NUMBER.
    
    Returns:
    
    True if this schema allows the type NUMBER.
  - isBoolean
```
public boolean isBoolean()
```
    Returns true if this schema allows the type BOOLEAN.
    
    Returns:
    
    True if this schema allows the type BOOLEAN.
  - isString
```
public boolean isString()
```
    Returns true if this schema allows the type STRING.
    
    Returns:
    
    True if this schema allows the type STRING.
  - isNull
```
public boolean isNull()
```
    Returns true if this schema allows the type NULL.
    
    Returns:
    
    True if this schema allows the type NULL.
  - needsFurtherUnfolding
```
public boolean needsFurtherUnfolding()
```
    Checks whether there are still some constraints in some sub-schemas that must be merged with the whole schema. When merging constraints from sub-schema defined in not, allOf, anyOf, or oneOf, it may happen that we end up with these keys again. In this case, we have to repeat the merging process to remove these keys. Note that the function may return false even if one of the above keys is still present, if the constraints inside the sub-schema can not be simplified by merging. These occurences must be handled explicitly by the generator or validator.
    
    Returns:
    
    true if there are constraints in sub-schemas that can be merged with this schema.
  - getRequiredPropertiesKeys
```
public Set<String> getRequiredPropertiesKeys()
                                      throws JSONSchemaException
```
    Gets the keys that are required in this schema's properties.
    
    Returns:
    
    A set with the keys that are required
    
    Throws:
    
    JSONSchemaException - If this schema does not allow the type OBJECT.
  - getRequiredProperties
```
public Map<String,JSONSchema> getRequiredProperties()
                                             throws JSONSchemaException
```
    Gets the pairs key-value that are required by this schema.
    
    Returns:
    
    A map with the required keys, and their corresponding sub-schema.
    
    Throws:
    
    JSONSchemaException - If this schema does not allow the type OBJECT.
  - getNonRequiredProperties
```
public Map<String,JSONSchema> getNonRequiredProperties()
                                                throws JSONSchemaException
```
    Gets the pairs key-value that are not required by this schema. The map contains the keys for additionalProperties and patternProperties, if they are allowed.
    
    Returns:
    
    A map with the non-required keys, and their corresponding sub-schema.
    
    Throws:
    
    JSONSchemaException - If this schema does not allow the type OBJECT.
  - dropAllOfAnyOfOneOfAndNot
```
public JSONSchema dropAllOfAnyOfOneOfAndNot()
                                     throws JSONSchemaException
```
    Returns a copy of this schema without the sub-schemas for allOf, anyOf, oneOf, and not.
    
    Returns:
    
    A partial copy of this schema
    
    Throws:
    
    JSONSchemaException - If it is not possible to construct a copy of this schema.
  - getAllOf
```
public JSONSchema getAllOf()
                    throws JSONSchemaException
```
    Gets a single schema obtained by merging together all the sub-schemas in the allOf array. If there is no allOf key, the true schema is returned.
    
    Returns:
    
    A single schema containing all the constraints given in allOf.
    
    Throws:
    
    JSONSchemaException
  - getAnyOf
```
public List<JSONSchema> getAnyOf()
                          throws JSONSchemaException
```
    Gets a list containing one schema by element in the anyOf array. If there is no anyOf key, a singleton list containing the true schema is returned.
    
    Returns:
    
    A list of schemas, one by element in the allOf array.
    
    Throws:
    
    JSONSchemaException
  - getOneOf
```
public List<JSONSchema> getOneOf()
                          throws JSONSchemaException
```
    Gets a list containing one possible combination of the elements in the oneOf array, by applying the XOR operation. If oneOf contains the elements A, B, C, then this function produces three schemas:
    - {A, "not": B, "not": C}
    - {"not": A, B, "not": C}
    - {"not": A, "not": B, C}
    That is, the function applies the definition of XOR on the elements. If there is no oneOf key, returns a singleton list containing the true schema.
    Returns:
    
    A list of all possible combinations.
    
    Throws:
    
    JSONSchemaException
  - merge
```
public JSONSchema merge(JSONSchema other)
                 throws JSONSchemaException
```
    Merge this schema with an other schema. The keys of the final schema is the union of the keys from both schemas. Keys that are defined in both schemas are merged (see the non-API documentation to more information).
    
    Parameters:
    
    other - The other schema
    
    Returns:
    
    A single schema obtained by merging the two schemas
    
    Throws:
    
    JSONSchemaException - If it is not possible to merge the schemas.
  - getRawNot
```
public JSONSchema getRawNot()
                     throws JSONSchemaException
```
    Get the contents of the key not, without any modifications.
    
    Returns:
    
    The sub-schema contained in the key not.
    
    Throws:
    
    JSONSchemaException - If it is not possible to construct the sub-schema.
  - getNot
```
public List<JSONSchema> getNot()
                        throws JSONSchemaException
```
    Gets a list of sub-schemas, after propagating the not inside each sub-schema. That is, if this schema contains "not": {A, B, C}, this function returns a list with three elements. Each element is obtained by applying the not inside A, B, and C, respectively. That is, it transforms a NOT AND into an OR NOT. If there is no not key, returns a singleton list with the true schema.
    
    Returns:
    
    Throws:
    
    JSONSchemaException
  - getSubSchemaProperties
```
public JSONSchema getSubSchemaProperties(String key)
                                  throws org.json.JSONException,
                                         JSONSchemaException
```
    Gets the sub-schema for the property key.
    
    Parameters:
    
    key - The key inside the properties.
    
    Returns:
    
    The sub-schema.
    
    Throws:
    
    org.json.JSONException - If the properties sub-schema does not contain key.
    
    JSONSchemaException - If it is not possible to construct the sub-schema.
  - getSubSchema
```
public JSONSchema getSubSchema(String key)
                        throws org.json.JSONException,
                               JSONSchemaException
```
    Gets the sub-schema for the key key.
    
    Parameters:
    
    key - The key.
    
    Returns:
    
    The sub-schema.
    
    Throws:
    
    org.json.JSONException - If this schema does not contain key.
    
    JSONSchemaException - If it is not possible to construct the sub-schema.
  - getItemsArray
```
public List<JSONSchema> getItemsArray()
                               throws JSONSchemaException
```
    Gets the sub-schemas for the items in an array.
    
    Returns:
    
    A list with the sub-schemas defining the items in an array.
    
    Throws:
    
    JSONSchemaException - If it is not possible to construct one of the sub-schemas.
  - getInt
```
public int getInt(String key)
```
  - getIntOr
```
public int getIntOr(String key,
                    int defaultValue)
```
  - getDouble
```
public double getDouble(String key)
```
  - getDoubleOr
```
public double getDoubleOr(String key,
                          double defaultValue)
```
  - getNumber
```
public Number getNumber(String key)
```
  - getNumberOr
```
public Number getNumberOr(String key,
                          Number defaultValue)
```
  - getString
```
public String getString(String key)
```
  - getStringOr
```
public String getStringOr(String key,
                          String defaultValue)
```
  - getBoolean
```
public boolean getBoolean(String key)
```
  - getBooleanOr
```
public boolean getBooleanOr(String key,
                            boolean defaultValue)
```
  - getStore
```
public JSONSchemaStore getStore()
```
    Returns the JSONSchemaStore holding this schema.
    
    Returns:
    
    The schema store
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class JSONSchema

Method Summary

Methods inherited from class java.lang.Object

Method Detail

depth

getAdditionalProperties

getAllKeysDefinedInSchema

getAllowedTypes

getForbiddenValues

getForbiddenValuesFilteredByType

getConstValue

getConstValueIfType

isEnum

isObject

isArray

isInteger

isNumber

isBoolean

isString

isNull

needsFurtherUnfolding

getRequiredPropertiesKeys

getRequiredProperties

getNonRequiredProperties

dropAllOfAnyOfOneOfAndNot

getAllOf

getAnyOf

getOneOf

merge

getRawNot

getNot

getSubSchemaProperties

getSubSchema

getItemsArray

getInt

getIntOr

getDouble

getDoubleOr

getNumber

getNumberOr

getString

getStringOr

getBoolean

getBooleanOr

getStore

toString