org.eel.kitchen.jsonschema.bundle

Class KeywordBundle

java.lang.Object

org.eel.kitchen.jsonschema.bundle.KeywordBundle

public final class KeywordBundle
extends Object

A keyword bundle

You can either create a new, completely empty, keyword bundle, 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, KeywordBundles, JsonSchemaFactory

Field Summary

Fields

Modifier and Type	Field and Description
private Map<String,SyntaxChecker>	syntaxCheckers
private Map<String,Class<? extends KeywordValidator>>	validators

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
Map<String,SyntaxChecker>	getSyntaxCheckers() Get the list of syntax checkers for this bundle
Map<String,Class<? extends KeywordValidator>>	getValidators() Get the list of keyword validators for this bundle
void	mergeWith(KeywordBundle other) Merge with another keyword bundle
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

syntaxCheckers

private final Map<String,SyntaxChecker> syntaxCheckers

validators

private final Map<String,Class<? extends KeywordValidator>> validators

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 if a keyword by the same name already exists, its syntax validator and keyword validator will be reset to the new values (and unregistered if any of these is null).

Parameters:

keyword - the keyword to register

See Also:

Keyword.Builder, Keyword

unregisterKeyword

public void unregisterKeyword(String name)

Unregister a keyword

Parameters:

name - the name of the keyword to unregister

mergeWith

public void mergeWith(KeywordBundle other)

Merge with another keyword bundle

Note: this operation is potentially dangerous if you are not careful. This method blindingly replaces the existing bundle's syntax checkers and keyword validators with those of the other bundle. Use with care!

Parameters:

other - the other bundle

getSyntaxCheckers

public Map<String,SyntaxChecker> getSyntaxCheckers()

Get the list of syntax checkers for this bundle

Returns:

a map of syntax checkers

getValidators

public Map<String,Class<? extends KeywordValidator>> getValidators()

Get the list of keyword validators for this bundle

Returns:

a map of keyword validators