org.eel.kitchen.jsonschema.main

Class JsonSchemaFactory.Builder

java.lang.Object

org.eel.kitchen.jsonschema.main.JsonSchemaFactory.Builder

Enclosing class:

JsonSchemaFactory

public static final class JsonSchemaFactory.Builder
extends Object

Builder class for a JsonSchemaFactory

Field Summary

Fields

Modifier and Type	Field and Description
private KeywordBundle	bundle The keyword bundle
private URI	namespace The namespace
private URIManager	uriManager The URI manager

Constructor Summary

Constructors

Constructor and Description
JsonSchemaFactory.Builder() No arg constructor
JsonSchemaFactory.Builder(KeywordBundle bundle) Main constructor

Method Summary

Methods

Modifier and Type	Method and Description
JsonSchemaFactory.Builder	addRedirection(String from, String to) Add an URI redirection
JsonSchemaFactory	build() Build the factory
JsonSchemaFactory.Builder	registerKeyword(Keyword keyword) Add a schema keyword to the bundle
JsonSchemaFactory.Builder	registerScheme(String scheme, URIDownloader downloader) Register a URIDownloader for a given scheme
JsonSchemaFactory.Builder	setNamespace(String namespace) Set the schema registry's namespace
JsonSchemaFactory.Builder	unregisterKeyword(String name) Unregister a schema keyword
JsonSchemaFactory.Builder	unregisterScheme(String scheme) Unregister a scheme

Methods inherited from class java.lang.Object

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

Field Detail

bundle

private final KeywordBundle bundle

The keyword bundle

uriManager

private final URIManager uriManager

The URI manager

namespace

private URI namespace

The namespace

Constructor Detail

JsonSchemaFactory.Builder

public JsonSchemaFactory.Builder()

No arg constructor

This calls the main constructor with KeywordBundles.defaultBundle() as an argument.

JsonSchemaFactory.Builder

public JsonSchemaFactory.Builder(KeywordBundle bundle)

Main constructor

Parameters:

bundle - the keyword bundle to use

Method Detail

registerScheme

public JsonSchemaFactory.Builder registerScheme(String scheme,
                                       URIDownloader downloader)

Register a URIDownloader for a given scheme

Parameters:

scheme - the URI scheme

downloader - the downloader

Returns:

the builder

Throws:

NullPointerException - scheme is null

IllegalArgumentException - illegal scheme

unregisterScheme

public JsonSchemaFactory.Builder unregisterScheme(String scheme)

Unregister a scheme

Parameters:

scheme - the scheme to desupport

Returns:

the builder

registerKeyword

public JsonSchemaFactory.Builder registerKeyword(Keyword keyword)

Add a schema keyword to the bundle

Parameters:

keyword - the keyword to add

Returns:

the builder

See Also:

Keyword

unregisterKeyword

public JsonSchemaFactory.Builder unregisterKeyword(String name)

Unregister a schema keyword

Parameters:

name - the name of the keyword to unregister

Returns:

the builder

setNamespace

public JsonSchemaFactory.Builder setNamespace(String namespace)

Set the schema registry's namespace

Parameters:

namespace - the namespace, as a string

Returns:

the builder

Throws:

IllegalArgumentException - invalid URI (see URI.create(String))

See Also:

SchemaRegistry

addRedirection

public JsonSchemaFactory.Builder addRedirection(String from,
                                       String to)

Add an URI redirection

This allows you to add an alias for a schema location so that it point to another of your choice. It may be useful if you have to resolve absolute JSON References normally unreachable, but you have a copy of this schema locally.

Note that both URIs must be absolute.

Parameters:

from - the source URI, as a string

to - the target URI, as a string

Returns:

the builder

Throws:

IllegalArgumentException - either of the arguments is an invalid URI, or it is not an absolute JSON Reference

See Also:

JsonRef

build

public JsonSchemaFactory build()

Build the factory

Returns:

the factory