org.eel.kitchen.jsonschema.bundle

Class KeywordBundle

java.lang.Object

org.eel.kitchen.jsonschema.bundle.KeywordBundle

All Implemented Interfaces:

Iterable<Map.Entry<String,Keyword>>

public final class KeywordBundle
extends Object
implements Iterable<Map.Entry<String,Keyword>>

A keyword bundle

You can either create a new, completely empty, keyword bunle, or use one of the default bundles and extend it. For instance:

     final KeywordBundle bundle = KeywordBundles.defaultBundle();

     final Keyword k1 = ...;
     final Keyword k2 = ...;

     bundle.registerKeyword(k1);
     bundle.registerKeyword(k2);
 

See Also:

Keyword, JsonSchemaFactory

Field Summary

Fields

Modifier and Type	Field and Description
private Map<String,Keyword>	keywords

Constructor Summary

Constructors

Constructor and Description
KeywordBundle()

Method Summary

Methods

Modifier and Type	Method and Description
(package private) KeywordBundle	copy() Package-private method to generate a full copy of this bundle
Iterator<Map.Entry<String,Keyword>>	iterator() Iterator over an unmodifiable copy of registered keywords
void	registerKeyword(Keyword keyword) Register a keyword for this bundle
void	unregisterKeyword(String name) Unregister a keyword

Methods inherited from class java.lang.Object

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

Field Detail

keywords

private final Map<String,Keyword> keywords

Constructor Detail

KeywordBundle

public KeywordBundle()

Method Detail

copy

KeywordBundle copy()

Package-private method to generate a full copy of this bundle

Returns:

an identical copy of this bundle

registerKeyword

public void registerKeyword(Keyword keyword)

Register a keyword for this bundle

Note that it is NOT allowed to register the same keyword twice. If you must do so, you must call unregisterKeyword(String) first.

Parameters:

keyword - the keyword to register

Throws:

IllegalArgumentException - a keyword by that name already exists

See Also:

Keyword.Builder, Keyword

unregisterKeyword

public void unregisterKeyword(String name)

Unregister a keyword

Parameters:

name - the name of the keyword to unregister

iterator

public Iterator<Map.Entry<String,Keyword>> iterator()

Iterator over an unmodifiable copy of registered keywords

Also used to implement Iterable

Specified by:

iterator in interface Iterable<Map.Entry<String,Keyword>>

Returns:

the iterator