com.github.fge.jsonschema.main

Class JsonSchemaFactory.Builder

java.lang.Object

com.github.fge.jsonschema.main.JsonSchemaFactory.Builder

Enclosing class:

JsonSchemaFactory

public static final class JsonSchemaFactory.Builder
extends Object

Builder class for a JsonSchemaFactory

Constructor Summary

Constructors

Constructor and Description
JsonSchemaFactory.Builder() Constructor

Method Summary

Methods

Modifier and Type	Method and Description
JsonSchemaFactory.Builder	addKeywordRegistry(JsonRef schemaURI, KeywordRegistry keywordRegistry, boolean byDefault) Deprecated.
JsonSchemaFactory.Builder	addMetaSchema(MetaSchema metaSchema, boolean byDefault)
JsonSchemaFactory.Builder	addRedirection(String from, String to) Add an URI redirection
JsonSchemaFactory.Builder	addressingMode(AddressingMode addressingMode) Sets the addressing mode for this factory
JsonSchemaFactory.Builder	addSchema(String uri, JsonNode schema) Register a schema
JsonSchemaFactory.Builder	addSchema(URI uri, JsonNode schema) Register a schema
JsonSchemaFactory	build() Build the factory
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	unregisterScheme(String scheme) Unregister a scheme

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonSchemaFactory.Builder

public JsonSchemaFactory.Builder()

Constructor

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

addressingMode

public JsonSchemaFactory.Builder addressingMode(AddressingMode addressingMode)

Sets the addressing mode for this factory

Parameters:

addressingMode - the addressing mode

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 from or to is an invalid URI, or it is not an absolute JSON Reference

See Also:

JsonRef

addKeywordRegistry

@Deprecated
public JsonSchemaFactory.Builder addKeywordRegistry(JsonRef schemaURI,
                                                      KeywordRegistry keywordRegistry,
                                                      boolean byDefault)

Deprecated.

Add a keyword registry to the factory

Parameters:

schemaURI - the URI for the new registry

keywordRegistry - the keyword registry

byDefault - whether this registry will be the default

Returns:

the builder

Throws:

NullPointerException - the URI or registry are null

addMetaSchema

public JsonSchemaFactory.Builder addMetaSchema(MetaSchema metaSchema,
                                      boolean byDefault)

addSchema

public JsonSchemaFactory.Builder addSchema(URI uri,
                                  JsonNode schema)

Register a schema

Parameters:

uri - the URI of this schema

schema - the schema

Returns:

the builder

See Also:

SchemaBundle.addSchema(URI, JsonNode)

addSchema

public JsonSchemaFactory.Builder addSchema(String uri,
                                  JsonNode schema)

Register a schema

Parameters:

uri - the URI of this schema

schema - the schema

Returns:

the builder

See Also:

SchemaBundle.addSchema(String, JsonNode)

build

public JsonSchemaFactory build()

Build the factory

Returns:

the factory