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. This is so that JsonSchema instances can be thread safe.

Unless you have several sets of keywords, 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.

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 FormatBundle	formatBundle Format bundle
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
JsonSchema	createSchema(SchemaContainer container) Create a schema from a container
private JsonSchema	createSchema(SchemaContainer container, JsonNode schema) Create a JsonSchema instance
JsonSchema	createSchema(SchemaContainer container, String path) Create a schema from a container, at a certain path
SchemaContainer	getSchema(String str) Get a schema container from a given URI
SchemaContainer	getSchema(URI uri) Get a schema container from a given URI
SchemaContainer	registerSchema(JsonNode schema) Register a schema

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

formatBundle

private final FormatBundle formatBundle

Format bundle

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

registerSchema

public SchemaContainer registerSchema(JsonNode schema)

Register a schema

Parameters:

schema - the raw schema

Returns:

a schema container to instantiate a JsonSchema

getSchema

public SchemaContainer getSchema(URI uri)
                          throws JsonSchemaException

Get a schema container from a given URI

This is the other way to obtain a container (the other is registerSchema(JsonNode)).

Parameters:

uri - the URI

Returns:

a schema container

Throws:

JsonSchemaException - cannot get schema from URI, or not a schema

See Also:

SchemaRegistry.get(URI)

getSchema

public SchemaContainer getSchema(String str)
                          throws JsonSchemaException

Get a schema container from a given URI

This calls getSchema(URI) and uses URI.create(String) to build the URI

Parameters:

str - the URI as a string

Returns:

a schema container

Throws:

JsonSchemaException - cannot get schema from URI, or not a schema

IllegalArgumentException - string is not a valid URI

See Also:

URI.create(String)

createSchema

public JsonSchema createSchema(SchemaContainer container)

Create a schema from a container

This is one of the constructors you will use. The other is createSchema(SchemaContainer, String).

Parameters:

container - the schema container

Returns:

a JsonSchema instance

createSchema

public JsonSchema createSchema(SchemaContainer container,
                      String path)

Create a schema from a container, at a certain path

For instance, if you register this schema:

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

then you can create a validator for schema1 using:

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

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

Parameters:

container - the schema container

path - the pointer/id reference into the schema

Returns:

a JsonSchema instance

createSchema

private JsonSchema createSchema(SchemaContainer container,
                      JsonNode schema)

Create a JsonSchema instance

Parameters:

container - the schema container

schema - the subschema

Returns:

a JsonSchema instance