org.eel.kitchen.jsonschema.bundle

Class Keyword

java.lang.Object

org.eel.kitchen.jsonschema.bundle.Keyword

public final class Keyword
extends Object

Class used to build a new keyword

The process is as follows:

• choose the name of the new keyword;
• create a SyntaxChecker for this keyword;
• create a KeywordValidator;
• create the keyword.

Sample code:

     final SyntaxChecker checker = ...;
     final Class<? extends KeywordValidator> validatorClass = ...;

     final Keyword myKeyword = Keyword.Builder.forKeyword("mykeyword")
         .withSyntaxChecker(checker).withValidatorClass(validatorClass)
         .build();

     // register it into a KeywordBundle, see link below
     bundle.registerKeyword(myKeyword);
 

It is perfectly legal to register a keyword with only a syntax checker, or only a keyword validator. An example is $schema, which must be a valid URI (therefore it has a syntax checker) but does not play any role in instance validation (therefore it has no keyword validator).

This class is thread safe and immutable.

See Also:

Keyword.Builder, SyntaxChecker, KeywordValidator, KeywordBundle

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Keyword.Builder Builder class for a new keyword

Field Summary

Fields

Modifier and Type	Field and Description
private String	name
private SyntaxChecker	syntaxChecker
private Class<? extends KeywordValidator>	validatorClass

Constructor Summary

Constructors

Modifier	Constructor and Description
private	Keyword(Keyword.Builder builder)

Method Summary

Methods

Modifier and Type	Method and Description
String	getName()
SyntaxChecker	getSyntaxChecker()
Class<? extends KeywordValidator>	getValidatorClass()

Methods inherited from class java.lang.Object

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

Field Detail

name

private final String name

syntaxChecker

private final SyntaxChecker syntaxChecker

validatorClass

private final Class<? extends KeywordValidator> validatorClass

Constructor Detail

Keyword

private Keyword(Keyword.Builder builder)

Method Detail

getName

public String getName()

getSyntaxChecker

public SyntaxChecker getSyntaxChecker()

getValidatorClass

public Class<? extends KeywordValidator> getValidatorClass()