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

You can create a factory with all default settings using defaultFactory(). This is what you will do in the vast majority of cases.

If you want to customize it, you need to go through JsonSchemaFactory.Builder.

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

Method Summary

Methods

Modifier and Type	Method and Description
JsonSchema	createSchema(SchemaContainer container) Deprecated. use one of the .from*() methods instead; scheduled for removal in 1.3+
JsonSchema	createSchema(SchemaContainer container, String path) Deprecated. use fromSchema(JsonNode, String) instead; scheduled for removal in 1.3+
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
SchemaContainer	getSchema(String str) Deprecated. use fromURI(String) instead; scheduled for removal in 1.3+
SchemaContainer	getSchema(URI uri) Deprecated. use fromURI(URI) instead; scheduled for removal in 1.3+
SchemaContainer	registerSchema(JsonNode schema) Deprecated. use fromSchema(JsonNode) instead; scheduled for removal in 1.3+

Methods inherited from class java.lang.Object

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

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 submit 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

IllegalArgumentException - URI is invalid

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

IllegalArgumentException - URI is invalid

See Also:

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

registerSchema

@Deprecated
public SchemaContainer registerSchema(JsonNode schema)

Deprecated. use fromSchema(JsonNode) instead; scheduled for removal in 1.3+

Register a schema

Parameters:

schema - the raw schema

Returns:

a schema container to instantiate a JsonSchema

getSchema

@Deprecated
public SchemaContainer getSchema(URI uri)
                          throws JsonSchemaException

Deprecated. use fromURI(URI) instead; scheduled for removal in 1.3+

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

@Deprecated
public SchemaContainer getSchema(String str)
                          throws JsonSchemaException

Deprecated. use fromURI(String) instead; scheduled for removal in 1.3+

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

@Deprecated
public JsonSchema createSchema(SchemaContainer container)

Deprecated. use one of the .from*() methods instead; scheduled for removal in 1.3+

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

@Deprecated
public JsonSchema createSchema(SchemaContainer container,
                                 String path)

Deprecated. use fromSchema(JsonNode, String) instead; scheduled for removal in 1.3+

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