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

Constructor Summary

Constructors

Constructor and Description
JsonSchemaFactory.Builder()

Method Summary

Methods

Modifier and Type	Method and Description
JsonSchemaFactory.Builder	addFormats(FormatBundle formatBundle) Merge the existing bundle with another, custom bundle
JsonSchemaFactory.Builder	addKeywords(KeywordBundle keywordBundle) Merge the existing keyword bundle with another, custom bundle
JsonSchemaFactory.Builder	addRedirection(String from, String to) Add an URI redirection
JsonSchemaFactory	build() Build the factory
JsonSchemaFactory.Builder	enableFeature(ValidationFeature feature) Enable a validation feature
JsonSchemaFactory.Builder	registerFormat(String fmt, FormatAttribute attribute) Register a format attribute
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	unregisterFormat(String fmt) Unregister a format attribute
JsonSchemaFactory.Builder	unregisterKeyword(String name) Unregister a schema keyword
JsonSchemaFactory.Builder	unregisterScheme(String scheme) Unregister a scheme
JsonSchemaFactory.Builder	withFormatBundle(FormatBundle formatBundle) Replace the format bundle with a custom bundle
JsonSchemaFactory.Builder	withKeywordBundle(KeywordBundle keywordBundle) Replace the keyword bundle with an entirely new bundle

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()

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

withKeywordBundle

public JsonSchemaFactory.Builder withKeywordBundle(KeywordBundle keywordBundle)

Replace the keyword bundle with an entirely new bundle

Use with caution!

Parameters:

keywordBundle - the bundle

Returns:

the builder

addKeywords

public JsonSchemaFactory.Builder addKeywords(KeywordBundle keywordBundle)

Merge the existing keyword bundle with another, custom bundle

Parameters:

keywordBundle - the bundle

Returns:

the builder

See Also:

KeywordBundle.mergeWith(KeywordBundle)

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

enableFeature

public JsonSchemaFactory.Builder enableFeature(ValidationFeature feature)

Enable a validation feature

Parameters:

feature - the feature to set

Returns:

the builder

registerFormat

public JsonSchemaFactory.Builder registerFormat(String fmt,
                                       FormatAttribute attribute)

Register a format attribute

Parameters:

fmt - the name for this attribute

attribute - the format attribute instance

Returns:

the builder

See Also:

FormatBundle.registerFormat(String, FormatAttribute)

unregisterFormat

public JsonSchemaFactory.Builder unregisterFormat(String fmt)

Unregister a format attribute

This is a no op if such a attribute was not registered.

Parameters:

fmt - the name for this attribute

Returns:

the builder

withFormatBundle

public JsonSchemaFactory.Builder withFormatBundle(FormatBundle formatBundle)

Replace the format bundle with a custom bundle

Use with caution! In particular, you should not mess with uri and regex.

Parameters:

formatBundle - the bundle

Returns:

the builder

See Also:

FormatBundle.defaultBundle()

addFormats

public JsonSchemaFactory.Builder addFormats(FormatBundle formatBundle)

Merge the existing bundle with another, custom bundle

Parameters:

formatBundle - the bundle

Returns:

the builder

See Also:

FormatBundle.mergeWith(FormatBundle)

build

public JsonSchemaFactory build()

Build the factory

Returns:

the factory