Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- ADDITIONAL_PROPERTIES - Static variable in class dev.harrel.jsonschema.Keyword
- ALL_OF - Static variable in class dev.harrel.jsonschema.Keyword
- ANCHOR - Static variable in class dev.harrel.jsonschema.Keyword
- Annotation - Interface in dev.harrel.jsonschema
-
Annotation
interface represents collected annotation. - ANY_OF - Static variable in class dev.harrel.jsonschema.Keyword
- ARRAY - Enum constant in enum class dev.harrel.jsonschema.SimpleType
- asArray() - Method in interface dev.harrel.jsonschema.JsonNode
-
Returns JSON node as an array.
- asArray() - Method in class dev.harrel.jsonschema.providers.GsonNode
- asArray() - Method in class dev.harrel.jsonschema.providers.JacksonNode
- asBoolean() - Method in interface dev.harrel.jsonschema.JsonNode
-
Returns JSON node as a boolean.
- asBoolean() - Method in class dev.harrel.jsonschema.providers.GsonNode
- asBoolean() - Method in class dev.harrel.jsonschema.providers.JacksonNode
- asInteger() - Method in interface dev.harrel.jsonschema.JsonNode
-
Returns JSON node as an integer.
- asInteger() - Method in class dev.harrel.jsonschema.providers.GsonNode
- asInteger() - Method in class dev.harrel.jsonschema.providers.JacksonNode
- asNumber() - Method in interface dev.harrel.jsonschema.JsonNode
-
Returns JSON node as a number.
- asNumber() - Method in class dev.harrel.jsonschema.providers.GsonNode
- asNumber() - Method in class dev.harrel.jsonschema.providers.JacksonNode
- asObject() - Method in interface dev.harrel.jsonschema.JsonNode
-
Returns JSON node as an object.
- asObject() - Method in class dev.harrel.jsonschema.providers.GsonNode
- asObject() - Method in class dev.harrel.jsonschema.providers.JacksonNode
- asString() - Method in interface dev.harrel.jsonschema.JsonNode
-
Returns JSON node as a string.
- asString() - Method in class dev.harrel.jsonschema.providers.GsonNode
- asString() - Method in class dev.harrel.jsonschema.providers.JacksonNode
B
- BOOLEAN - Enum constant in enum class dev.harrel.jsonschema.SimpleType
C
- COMMENT - Static variable in class dev.harrel.jsonschema.Keyword
- CompositeSchemaResolver - Class in dev.harrel.jsonschema
-
CompositeSchemaResolver
class aggregates multipleSchemaResolver
s into one. - CONST - Static variable in class dev.harrel.jsonschema.Keyword
- CONTAINS - Static variable in class dev.harrel.jsonschema.Keyword
- create(SchemaParsingContext, String, JsonNode) - Method in class dev.harrel.jsonschema.Draft2020EvaluatorFactory
- create(SchemaParsingContext, String, JsonNode) - Method in interface dev.harrel.jsonschema.EvaluatorFactory
-
This method will be invoked for each JSON object field during schema parsing process.
- create(String) - Method in interface dev.harrel.jsonschema.JsonNodeFactory
-
Creates
JsonNode
from raw JSON string. - create(String) - Method in class dev.harrel.jsonschema.providers.GsonNode.Factory
- create(String) - Method in class dev.harrel.jsonschema.providers.JacksonNode.Factory
- createValidator() - Method in class dev.harrel.jsonschema.ValidatorFactory
-
Creates new instance of
Validator
using current configuration.
D
- DEFS - Static variable in class dev.harrel.jsonschema.Keyword
- DEPENDENT_REQUIRED - Static variable in class dev.harrel.jsonschema.Keyword
- DEPENDENT_SCHEMAS - Static variable in class dev.harrel.jsonschema.Keyword
- dev.harrel.jsonschema - package dev.harrel.jsonschema
- dev.harrel.jsonschema.providers - package dev.harrel.jsonschema.providers
- Draft2020EvaluatorFactory - Class in dev.harrel.jsonschema
-
EvaluatorFactory
implementation that supports 2020 draft specification. - Draft2020EvaluatorFactory() - Constructor for class dev.harrel.jsonschema.Draft2020EvaluatorFactory
- DYNAMIC_ANCHOR - Static variable in class dev.harrel.jsonschema.Keyword
- DYNAMIC_REF - Static variable in class dev.harrel.jsonschema.Keyword
E
- ELSE - Static variable in class dev.harrel.jsonschema.Keyword
- empty() - Static method in class dev.harrel.jsonschema.SchemaResolver.Result
-
Factory method for empty result.
- ENUM - Static variable in class dev.harrel.jsonschema.Keyword
- Error - Interface in dev.harrel.jsonschema
-
Error
interface represents validation error. - evaluate(EvaluationContext, JsonNode) - Method in interface dev.harrel.jsonschema.Evaluator
-
Evaluation logic for a specific keyword.
- EvaluationContext - Class in dev.harrel.jsonschema
-
EvaluationContext
class represents state of current evaluation (instance validation against schema). - Evaluator - Interface in dev.harrel.jsonschema
-
Evaluator
interface is the main abstraction for the keyword evaluation logic. - Evaluator.Result - Class in dev.harrel.jsonschema
-
Result
class represents evaluation outcome. - EvaluatorFactory - Interface in dev.harrel.jsonschema
-
EvaluatorFactory
interface is responsible for creation ofEvaluator
instances. - evaluatorsMap - Variable in class dev.harrel.jsonschema.Draft2020EvaluatorFactory
- EXCLUSIVE_MAXIMUM - Static variable in class dev.harrel.jsonschema.Keyword
- EXCLUSIVE_MINIMUM - Static variable in class dev.harrel.jsonschema.Keyword
F
- Factory() - Constructor for class dev.harrel.jsonschema.providers.GsonNode.Factory
- Factory() - Constructor for class dev.harrel.jsonschema.providers.JacksonNode.Factory
- Factory(ObjectMapper) - Constructor for class dev.harrel.jsonschema.providers.JacksonNode.Factory
- failure() - Static method in class dev.harrel.jsonschema.Evaluator.Result
-
Factory method for failed evaluation result.
- failure(String) - Static method in class dev.harrel.jsonschema.Evaluator.Result
-
Factory method for failed evaluation result with message.
- fromJsonNode(JsonNode) - Static method in class dev.harrel.jsonschema.SchemaResolver.Result
-
Factory method for
JsonNode
- fromName(String) - Static method in enum class dev.harrel.jsonschema.SimpleType
-
Helper method for getting
SimpleType
from JSON schema types. - fromProviderNode(Object) - Static method in class dev.harrel.jsonschema.SchemaResolver.Result
-
Factory method for JSON provider node
- fromString(String) - Static method in class dev.harrel.jsonschema.SchemaResolver.Result
-
Factory method for raw JSON string
G
- getAbsoluteUri(JsonNode) - Method in class dev.harrel.jsonschema.SchemaParsingContext
-
Calculates absolute URI to the provided
JsonNode
. - getAbsoluteUri(String) - Method in class dev.harrel.jsonschema.SchemaParsingContext
-
Calculates absolute URI for the corresponding JSON pointer.
- getAnnotation() - Method in interface dev.harrel.jsonschema.Annotation
-
Returns collected annotation.
- getAnnotation() - Method in class dev.harrel.jsonschema.Evaluator.Result
- getAnnotations() - Method in class dev.harrel.jsonschema.Validator.Result
-
Returns collected annotation during schema validation.
- getCurrentSchemaObject() - Method in class dev.harrel.jsonschema.SchemaParsingContext
-
Returns JSON object which is currently being parsed in form of map.
- getError() - Method in interface dev.harrel.jsonschema.Error
-
Returns validation error.
- getErrors() - Method in exception dev.harrel.jsonschema.InvalidSchemaException
-
Errors getter.
- getErrors() - Method in class dev.harrel.jsonschema.Validator.Result
-
Returns validation errors.
- getEvaluationItems() - Method in class dev.harrel.jsonschema.EvaluationContext
-
Returns collected annotations up to this point.
- getEvaluationPath() - Method in interface dev.harrel.jsonschema.ResultItem
-
Returns JSON pointer like path representing evaluation point in schema JSON.
- getInstanceLocation() - Method in interface dev.harrel.jsonschema.ResultItem
-
Returns JSON pointer like path representing evaluation point in instance JSON.
- getJsonPointer() - Method in interface dev.harrel.jsonschema.JsonNode
-
JSON pointer getter.
- getJsonPointer() - Method in class dev.harrel.jsonschema.providers.GsonNode
- getJsonPointer() - Method in class dev.harrel.jsonschema.providers.JacksonNode
- getKeyword() - Method in interface dev.harrel.jsonschema.ResultItem
-
Returns keyword name associated with given evaluation point.
- getName() - Method in enum class dev.harrel.jsonschema.SimpleType
-
Name getter.
- getNodeType() - Method in interface dev.harrel.jsonschema.JsonNode
-
Node type getter
- getNodeType() - Method in class dev.harrel.jsonschema.providers.GsonNode
- getNodeType() - Method in class dev.harrel.jsonschema.providers.JacksonNode
- getOrder() - Method in interface dev.harrel.jsonschema.Evaluator
-
Order of
Evaluator
determines order of evaluators execution in scope of single schema location. - getParentUri() - Method in class dev.harrel.jsonschema.SchemaParsingContext
-
Returns URI of the closest parent schema that contains $id keyword.
- getRef() - Method in exception dev.harrel.jsonschema.SchemaNotFoundException
-
Schema ref getter.
- getSchemaLocation() - Method in interface dev.harrel.jsonschema.ResultItem
-
Returns absolute schema location which uniquely identifies given schema.
- GsonNode - Class in dev.harrel.jsonschema.providers
- GsonNode(JsonElement) - Constructor for class dev.harrel.jsonschema.providers.GsonNode
- GsonNode.Factory - Class in dev.harrel.jsonschema.providers
I
- ID - Static variable in class dev.harrel.jsonschema.Keyword
- IF - Static variable in class dev.harrel.jsonschema.Keyword
- INTEGER - Enum constant in enum class dev.harrel.jsonschema.SimpleType
- InvalidSchemaException - Exception in dev.harrel.jsonschema
-
Exception type used to indicate that schema has failed validation against meta-schema.
- isArray() - Method in interface dev.harrel.jsonschema.JsonNode
-
Checks if JSON node is an array.
- isBoolean() - Method in interface dev.harrel.jsonschema.JsonNode
-
Checks if JSON node is a boolean.
- isEqualTo(JsonNode) - Method in interface dev.harrel.jsonschema.JsonNode
-
Equality check between two
JsonNode
s. - isInteger() - Method in interface dev.harrel.jsonschema.JsonNode
-
Checks if JSON node is an integer.
- isInteger() - Method in class dev.harrel.jsonschema.providers.GsonNode
- isNull() - Method in interface dev.harrel.jsonschema.JsonNode
-
Checks if JSON node is null.
- isNumber() - Method in interface dev.harrel.jsonschema.JsonNode
-
Checks if JSON node is a number.
- isNumber() - Method in class dev.harrel.jsonschema.providers.GsonNode
- isObject() - Method in interface dev.harrel.jsonschema.JsonNode
-
Checks if JSON node is an object.
- isString() - Method in interface dev.harrel.jsonschema.JsonNode
-
Checks if JSON node is a string.
- isValid() - Method in class dev.harrel.jsonschema.Validator.Result
-
Checks if validation was successful.
- ITEMS - Static variable in class dev.harrel.jsonschema.Keyword
J
- JacksonNode - Class in dev.harrel.jsonschema.providers
- JacksonNode(JsonNode) - Constructor for class dev.harrel.jsonschema.providers.JacksonNode
- JacksonNode.Factory - Class in dev.harrel.jsonschema.providers
- JsonNode - Interface in dev.harrel.jsonschema
-
JsonNode
interface is the main abstraction for provider-agnostic JSON node. - JsonNodeFactory - Interface in dev.harrel.jsonschema
-
JsonNodeFactory
interface is the main abstraction for provider-agnostic JSON factory. - JsonSchemaException - Exception in dev.harrel.jsonschema
-
Base exception class for
dev.harrel.jsonschema
.
K
- Keyword - Class in dev.harrel.jsonschema
-
Keyword
class exposes keyword names in form of static final fields.
M
- MAX_CONTAINS - Static variable in class dev.harrel.jsonschema.Keyword
- MAX_ITEMS - Static variable in class dev.harrel.jsonschema.Keyword
- MAX_LENGTH - Static variable in class dev.harrel.jsonschema.Keyword
- MAX_PROPERTIES - Static variable in class dev.harrel.jsonschema.Keyword
- MAXIMUM - Static variable in class dev.harrel.jsonschema.Keyword
- MetaSchemaResolvingException - Exception in dev.harrel.jsonschema
-
Exception type used to indicate meta-schema resolution failure.
- MIN_CONTAINS - Static variable in class dev.harrel.jsonschema.Keyword
- MIN_ITEMS - Static variable in class dev.harrel.jsonschema.Keyword
- MIN_LENGTH - Static variable in class dev.harrel.jsonschema.Keyword
- MIN_PROPERTIES - Static variable in class dev.harrel.jsonschema.Keyword
- MINIMUM - Static variable in class dev.harrel.jsonschema.Keyword
- MULTIPLE_OF - Static variable in class dev.harrel.jsonschema.Keyword
N
- NOT - Static variable in class dev.harrel.jsonschema.Keyword
- NULL - Enum constant in enum class dev.harrel.jsonschema.SimpleType
- NUMBER - Enum constant in enum class dev.harrel.jsonschema.SimpleType
O
- OBJECT - Enum constant in enum class dev.harrel.jsonschema.SimpleType
- of(SchemaResolver...) - Static method in class dev.harrel.jsonschema.CompositeSchemaResolver
-
Factory method for composing multiple resolvers.
- ONE_OF - Static variable in class dev.harrel.jsonschema.Keyword
P
- PATTERN - Static variable in class dev.harrel.jsonschema.Keyword
- PATTERN_PROPERTIES - Static variable in class dev.harrel.jsonschema.Keyword
- PREFIX_ITEMS - Static variable in class dev.harrel.jsonschema.Keyword
- PROPERTIES - Static variable in class dev.harrel.jsonschema.Keyword
- PROPERTY_NAMES - Static variable in class dev.harrel.jsonschema.Keyword
R
- REF - Static variable in class dev.harrel.jsonschema.Keyword
- registerSchema(JsonNode) - Method in class dev.harrel.jsonschema.Validator
-
Registers schema and generates URI for it.
- registerSchema(Object) - Method in class dev.harrel.jsonschema.Validator
-
Registers schema and generates URI for it.
- registerSchema(String) - Method in class dev.harrel.jsonschema.Validator
-
Registers schema and generates URI for it.
- registerSchema(URI, JsonNode) - Method in class dev.harrel.jsonschema.Validator
-
Registers schema at specified URI.
- registerSchema(URI, Object) - Method in class dev.harrel.jsonschema.Validator
-
Registers schema at specified URI.
- registerSchema(URI, String) - Method in class dev.harrel.jsonschema.Validator
-
Registers schema at specified URI.
- REQUIRED - Static variable in class dev.harrel.jsonschema.Keyword
- resolve(String) - Method in class dev.harrel.jsonschema.CompositeSchemaResolver
- resolve(String) - Method in interface dev.harrel.jsonschema.SchemaResolver
-
Resolves URI string to schema representation
- resolveDynamicRefAndValidate(String, JsonNode) - Method in class dev.harrel.jsonschema.EvaluationContext
-
Dynamically resolves schema using provided reference string, and then validates instance node against it.
- resolveInternalRefAndValidate(String, JsonNode) - Method in class dev.harrel.jsonschema.EvaluationContext
-
Resolves internal schema using provided reference string and then validates instance node against it.
- resolveRefAndValidate(String, JsonNode) - Method in class dev.harrel.jsonschema.EvaluationContext
-
Resolves schema using provided reference string, and then validates instance node against it.
- ResultItem - Interface in dev.harrel.jsonschema
-
ResultItem
interface provides methods which can uniquely identify specific point in validation flow.
S
- SCHEMA - Static variable in class dev.harrel.jsonschema.Keyword
- SchemaNotFoundException - Exception in dev.harrel.jsonschema
-
Exception type used to indicate that resolution of specific schema has failed.
- SchemaParsingContext - Class in dev.harrel.jsonschema
-
SchemaParsingContext
class represents state of current schema parsing process. - SchemaResolver - Interface in dev.harrel.jsonschema
-
SchemaResolver
interface is the main abstraction for external schemas' resolution. - SchemaResolver.Result - Class in dev.harrel.jsonschema
-
Result
class represents schema resolution outcome. - SimpleType - Enum Class in dev.harrel.jsonschema
-
SimpleType
enum represent all types allowed in JSON schema specification. - STRING - Enum constant in enum class dev.harrel.jsonschema.SimpleType
- success() - Static method in class dev.harrel.jsonschema.Evaluator.Result
-
Factory method for successful evaluation result.
- success(Object) - Static method in class dev.harrel.jsonschema.Evaluator.Result
-
Factory method for successful evaluation result with annotation.
T
- THEN - Static variable in class dev.harrel.jsonschema.Keyword
- toPrintableString() - Method in interface dev.harrel.jsonschema.JsonNode
-
Converts JSON node to printable string.
- toPrintableString() - Method in class dev.harrel.jsonschema.providers.GsonNode
- TYPE - Static variable in class dev.harrel.jsonschema.Keyword
U
- UNEVALUATED_ITEMS - Static variable in class dev.harrel.jsonschema.Keyword
- UNEVALUATED_PROPERTIES - Static variable in class dev.harrel.jsonschema.Keyword
- UNIQUE_ITEMS - Static variable in class dev.harrel.jsonschema.Keyword
V
- validate(JsonNode, JsonNode) - Method in class dev.harrel.jsonschema.ValidatorFactory
-
Validates JSON instance against schema.
- validate(JsonNode, Object) - Method in class dev.harrel.jsonschema.ValidatorFactory
-
Validates JSON instance against schema.
- validate(JsonNode, String) - Method in class dev.harrel.jsonschema.ValidatorFactory
-
Validates JSON instance against schema.
- validate(Object, JsonNode) - Method in class dev.harrel.jsonschema.ValidatorFactory
-
Validates JSON instance against schema.
- validate(Object, Object) - Method in class dev.harrel.jsonschema.ValidatorFactory
-
Validates JSON instance against schema.
- validate(Object, String) - Method in class dev.harrel.jsonschema.ValidatorFactory
-
Validates JSON instance against schema.
- validate(String, JsonNode) - Method in class dev.harrel.jsonschema.ValidatorFactory
-
Validates JSON instance against schema.
- validate(String, Object) - Method in class dev.harrel.jsonschema.ValidatorFactory
-
Validates JSON instance against schema.
- validate(String, String) - Method in class dev.harrel.jsonschema.ValidatorFactory
-
Validates JSON instance against schema.
- validate(URI, JsonNode) - Method in class dev.harrel.jsonschema.Validator
-
Validates instance JSON against schema resolved from provided URI.
- validate(URI, Object) - Method in class dev.harrel.jsonschema.Validator
-
Validates instance JSON against schema resolved from provided URI.
- validate(URI, String) - Method in class dev.harrel.jsonschema.Validator
-
Validates instance JSON against schema resolved from provided URI.
- Validator - Class in dev.harrel.jsonschema
-
Main class for performing JSON schema validation.
- Validator.Result - Class in dev.harrel.jsonschema
-
Result
class represents validation outcome. - ValidatorFactory - Class in dev.harrel.jsonschema
-
Configurable factory for
Validator
class. - ValidatorFactory() - Constructor for class dev.harrel.jsonschema.ValidatorFactory
- valueOf(String) - Static method in enum class dev.harrel.jsonschema.SimpleType
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class dev.harrel.jsonschema.SimpleType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- VOCABULARY - Static variable in class dev.harrel.jsonschema.Keyword
W
- withDefaultMetaSchemaUri(String) - Method in class dev.harrel.jsonschema.ValidatorFactory
-
Sets default meta-schema URI.
- withEvaluatorFactory(EvaluatorFactory) - Method in class dev.harrel.jsonschema.ValidatorFactory
-
Sets
EvaluatorFactory
. - withJsonNodeFactory(JsonNodeFactory) - Method in class dev.harrel.jsonschema.ValidatorFactory
-
Sets
JsonNodeFactory
. - withSchemaResolver(SchemaResolver) - Method in class dev.harrel.jsonschema.ValidatorFactory
-
Composes
SchemaResolver
with default schema resolver. - wrap(Object) - Method in interface dev.harrel.jsonschema.JsonNodeFactory
-
Wraps provider specific JSON node into
JsonNode
. - wrap(Object) - Method in class dev.harrel.jsonschema.providers.GsonNode.Factory
- wrap(Object) - Method in class dev.harrel.jsonschema.providers.JacksonNode.Factory
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form