com.github.fge.jsonschema.load.configuration

Class LoadingConfigurationBuilder

java.lang.Object

com.github.fge.jsonschema.load.configuration.LoadingConfigurationBuilder

All Implemented Interfaces:

com.github.fge.Thawed<LoadingConfiguration>

public final class LoadingConfigurationBuilder
extends Object
implements com.github.fge.Thawed<LoadingConfiguration>

Loading configuration (mutable instance)

See Also:

LoadingConfiguration

Method Summary

Methods

Modifier and Type	Method and Description
LoadingConfigurationBuilder	addSchemaRedirect(String source, String destination) Add a schema redirection
LoadingConfigurationBuilder	addScheme(String scheme, URIDownloader downloader) Add a new URI downloader
LoadingConfigurationBuilder	dereferencing(Dereferencing dereferencing) Set the dereferencing mode for this loading configuration
LoadingConfiguration	freeze() freeze this configuration
LoadingConfigurationBuilder	preloadSchema(JsonNode schema) Preload a schema
LoadingConfigurationBuilder	preloadSchema(String uri, JsonNode schema) Preload a schema at a given URI
LoadingConfigurationBuilder	removeScheme(String scheme) Remove a downloader for a given scheme
LoadingConfigurationBuilder	setNamespace(String input) Set the default namespace for that loading configuration

Methods inherited from class java.lang.Object

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

Method Detail

addScheme

public LoadingConfigurationBuilder addScheme(String scheme,
                                    URIDownloader downloader)

Add a new URI downloader

Parameters:

scheme - the scheme

downloader - the downloader

Returns:

this

Throws:

NullPointerException - scheme or downloader is null

IllegalArgumentException - illegal scheme

removeScheme

public LoadingConfigurationBuilder removeScheme(String scheme)

Remove a downloader for a given scheme

Parameters:

scheme - the scheme

Returns:

this

setNamespace

public LoadingConfigurationBuilder setNamespace(String input)

Set the default namespace for that loading configuration

Parameters:

input - the namespace

Returns:

this

Throws:

NullPointerException - input is null

IllegalArgumentException - input is not an absolute JSON Reference

See Also:

JsonRef

dereferencing

public LoadingConfigurationBuilder dereferencing(Dereferencing dereferencing)

Set the dereferencing mode for this loading configuration

By default, it is Dereferencing.CANONICAL.

Parameters:

dereferencing - the dereferencing mode

Returns:

this

Throws:

NullPointerException - dereferencing mode is null

addSchemaRedirect

public LoadingConfigurationBuilder addSchemaRedirect(String source,
                                            String destination)

Add a schema redirection

Parameters:

source - URI of the source schema

destination - URI to redirect to

Returns:

this

Throws:

NullPointerException - source or destination is null

IllegalArgumentException - source and destination are the same URI

See Also:

JsonRef

preloadSchema

public LoadingConfigurationBuilder preloadSchema(String uri,
                                        JsonNode schema)

Preload a schema at a given URI

Use this if the schema you wish to preload does not have an absolute id at the top level.

Note that the syntax of the schema is not checked at this stage.

Parameters:

uri - the URI to use

schema - the schema

Returns:

this

Throws:

NullPointerException - the URI or schema is null

IllegalArgumentException - a schema already exists at this URI

See Also:

JsonRef

preloadSchema

public LoadingConfigurationBuilder preloadSchema(JsonNode schema)

Preload a schema

Use this if the schema already has an absolute id.

Parameters:

schema - the schema

Returns:

this

Throws:

NullPointerException - schema is null

IllegalArgumentException - schema has no id, or its id is not an absolute JSON Reference

See Also:

JsonRef

freeze

public LoadingConfiguration freeze()

freeze this configuration

Specified by:

freeze in interface com.github.fge.Thawed<LoadingConfiguration>

Returns:

a frozen copy of this builder