org.eel.kitchen.jsonschema.format

Class FormatBundle

java.lang.Object

org.eel.kitchen.jsonschema.format.FormatBundle

public final class FormatBundle
extends Object

A format specifiers bundle

You can either create a bundle with all builtin format specifiers (see below for the list), or an empty one which you have to fill yourself. The methods to use for these are respectively defaultBundle() and newBundle().

The default bundle will contain validators (FormatSpecifier instances) for the following format attributes:

• date-time,
• email,
• host-name,
• ip-address,
• ipv6,
• regex,
• uri,

Other format attributes defined by the specification are hosted in a different package: json-schema-formats.

you can override these, but it is not advised that you do so: they have been carefully designed so as to conform to the specification as closely as possible -- in particular, leave regex alone (see RhinoHelper).

See Also:

FormatSpecifier

Field Summary

Fields

Modifier and Type	Field and Description
private static Map<String,FormatSpecifier>	BUILTIN_FORMATS The builtin format specifiers
private Map<String,FormatSpecifier>	specifiers This bundle's specifiers

Constructor Summary

Constructors

Modifier	Constructor and Description
private	FormatBundle() Constructor for a completely empty bundle
private	FormatBundle(Map<String,FormatSpecifier> specifiers) Constructor with a provided specifier map

Method Summary

Methods

Modifier and Type	Method and Description
static FormatBundle	defaultBundle() Create a new bundle with the default format specifier set
Map<String,FormatSpecifier>	getSpecifiers() Get an immutable map of this bundle's specifiers
void	mergeWith(FormatBundle other) Merge with another bundle
static FormatBundle	newBundle() Create a new, empty bundle
void	registerFormat(String fmt, FormatSpecifier specifier) Register a new format specifier
String	toString()
void	unregisterFormat(String fmt) Unregister a specifier

Methods inherited from class java.lang.Object

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

Field Detail

BUILTIN_FORMATS

private static final Map<String,FormatSpecifier> BUILTIN_FORMATS

The builtin format specifiers

specifiers

private final Map<String,FormatSpecifier> specifiers

This bundle's specifiers

Constructor Detail

FormatBundle

private FormatBundle()

Constructor for a completely empty bundle

FormatBundle

private FormatBundle(Map<String,FormatSpecifier> specifiers)

Constructor with a provided specifier map

Parameters:

specifiers - the specifiers list

Method Detail

newBundle

public static FormatBundle newBundle()

Create a new, empty bundle

Returns:

the bundle

defaultBundle

public static FormatBundle defaultBundle()

Create a new bundle with the default format specifier set

Returns:

the bundle

registerFormat

public void registerFormat(String fmt,
                  FormatSpecifier specifier)

Register a new format specifier

Note: it will unconditionally override any existing specifier, so be careful!

Parameters:

fmt - the format specifier name

specifier - the specifier instance

unregisterFormat

public void unregisterFormat(String fmt)

Unregister a specifier

Parameters:

fmt - the specifier name

mergeWith

public void mergeWith(FormatBundle other)

Merge with another bundle

Note that specifiers defined in the bundle given as an argument will happily override those defined in the current bundle. Use with care!

Parameters:

other - the other bundle

getSpecifiers

public Map<String,FormatSpecifier> getSpecifiers()

Get an immutable map of this bundle's specifiers

Returns:

a map of this bundle instance's specifiers

toString

public String toString()

Overrides:

toString in class Object