org.eel.kitchen.jsonschema.format

Class FormatBundle

java.lang.Object

org.eel.kitchen.jsonschema.format.FormatBundle

public final class FormatBundle
extends Object

A bundle of format attributes

You can either create a bundle with all builtin format attributes (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 (FormatAttribute 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:

FormatAttribute

Method Summary

Methods

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

Methods inherited from class java.lang.Object

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

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 attribute set

Returns:

the bundle

registerFormat

public void registerFormat(String fmt,
                  FormatAttribute attribute)

Register a new format attribute

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

Parameters:

fmt - the format attribute name

attribute - the attribute instance

unregisterFormat

public void unregisterFormat(String fmt)

Unregister a attribute

Parameters:

fmt - the attribute name

mergeWith

public void mergeWith(FormatBundle other)

Merge with another bundle

Note that attributes 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

getAttributes

public Map<String,FormatAttribute> getAttributes()

Get an immutable map of this bundle's attributes

Returns:

a map of this bundle instance's attributes

toString

public String toString()

Overrides:

toString in class Object