org.eel.kitchen.jsonschema.main

Class JsonSchemaFactory

java.lang.Object

org.eel.kitchen.jsonschema.main.JsonSchemaFactory

public final class JsonSchemaFactory
extends Object

Factory to build JSON Schema validating instances

This class cannot be instantiated directly, you need to go through its included JsonSchemaFactory.Builder to do that.

Unless you have several sets of custom keywords and/or format specifiers, you will probably only ever need one of these. It caches syntax validation results and keyword validators to speed up validation (quite a bit).

This class is thread safe and immutable.

See Also:

JsonSchema

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JsonSchemaFactory.Builder Builder class for a JsonSchemaFactory

Field Summary

Fields

Modifier and Type	Field and Description
private JsonValidatorCache	cache Validator cache
private EnumSet<ValidationFeature>	features List of supported features
private SchemaRegistry	registry Schema registry

Constructor Summary

Constructors

Modifier	Constructor and Description
private	JsonSchemaFactory(JsonSchemaFactory.Builder builder) Constructor, private by design

Method Summary

Methods

Modifier and Type	Method and Description
private JsonSchema	createSchema(SchemaContainer container, JsonNode schema) Create a JsonSchema instance
static JsonSchemaFactory	defaultFactory() Build a factory with all default settings
JsonSchema	fromSchema(JsonNode schema) Create a schema instance from a JSON Schema
JsonSchema	fromSchema(JsonNode schema, String path) Create a schema instance from a JSON Schema, at a certain path
JsonSchema	fromURI(String str) Create a schema instance from a JSON Schema located at a given URI
JsonSchema	fromURI(String str, String path) Create a schema instance from a JSON Schema located at a given URI and at a given path
JsonSchema	fromURI(URI uri) Create a schema instance from a JSON Schema located at a given URI
JsonSchema	fromURI(URI uri, String path) Create a schema instance from a JSON Schema located at a given URI, and at a given path

Methods inherited from class java.lang.Object

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

Field Detail

registry

private final SchemaRegistry registry

Schema registry

cache

private final JsonValidatorCache cache

Validator cache

features

private final EnumSet<ValidationFeature> features

List of supported features

Constructor Detail

JsonSchemaFactory

private JsonSchemaFactory(JsonSchemaFactory.Builder builder)

Constructor, private by design

Parameters:

builder - the builder

See Also:

JsonSchemaFactory.Builder

Method Detail

defaultFactory

public static JsonSchemaFactory defaultFactory()

Build a factory with all default settings

Returns:

a schema factory instance

fromSchema

public JsonSchema fromSchema(JsonNode schema,
                    String path)

Create a schema instance from a JSON Schema, at a certain path

For instance, if you submi this schema:

     {
         "schema1": { ... },
         "schema2": { ... }
     }
 

then you can create a validator for schema1 using:

     final JsonSchema schema = factory.create(schema, "#/schema1");
 

The path can be a JsonPointer as above, but also an id reference.

Parameters:

schema - the schema

path - the pointer/id reference into the schema

Returns:

a JsonSchema instance

See Also:

JsonFragment

fromSchema

public JsonSchema fromSchema(JsonNode schema)

Create a schema instance from a JSON Schema

This calls fromSchema(JsonNode, String) with "" as a path.

Parameters:

schema - the schema

Returns:

a JsonSchema instance

fromURI

public JsonSchema fromURI(URI uri,
                 String path)
                   throws JsonSchemaException

Create a schema instance from a JSON Schema located at a given URI, and at a given path

This allows you, for instance, to load a schema using HTTP. Or, in fact, any other URI scheme that is supported.

Parameters:

uri - the URI

path - the JSON Pointer/id reference into the downloaded schema

Returns:

a JsonSchema instance

Throws:

JsonSchemaException - unable to get content from that URI

See Also:

URIManager, SchemaRegistry

fromURI

public JsonSchema fromURI(URI uri)
                   throws JsonSchemaException

Create a schema instance from a JSON Schema located at a given URI

Parameters:

uri - the URI

Returns:

a JsonSchema instance

Throws:

JsonSchemaException - unable to get content from that URI

See Also:

fromSchema(JsonNode, String)

fromURI

public JsonSchema fromURI(String str)
                   throws JsonSchemaException

Create a schema instance from a JSON Schema located at a given URI

Parameters:

str - the URI as a string

Returns:

a JsonSchema instance

Throws:

JsonSchemaException - unable to get content from that URI

See Also:

URI.create(String), fromURI(URI, String)

fromURI

public JsonSchema fromURI(String str,
                 String path)
                   throws JsonSchemaException

Create a schema instance from a JSON Schema located at a given URI and at a given path

Parameters:

str - the URI as a string

path - the JSON Pointer/id reference into the downloaded schema

Returns:

a JsonSchema instance

Throws:

JsonSchemaException - unable to get content from that URI

See Also:

URI.create(String), fromURI(URI, String)

createSchema

private JsonSchema createSchema(SchemaContainer container,
                      JsonNode schema)

Create a JsonSchema instance

Parameters:

container - the schema container

schema - the subschema

Returns:

a JsonSchema instance