com.github.fge.jsonschema.main

Class Keyword

java.lang.Object

com.github.fge.jsonschema.main.Keyword

public final class Keyword
extends Object

Representation of a schema keyword: its name, syntax checker and validator

The process is as follows:

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

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, KeywordRegistry

Nested Class Summary

Nested Classes

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

Method Summary

Methods

Modifier and Type	Method and Description
String	getName()
SyntaxChecker	getSyntaxChecker()
Class<? extends KeywordValidator>	getValidatorClass()
static Keyword.Builder	withName(String name) Create a new Keyword.Builder for a keyword with a given name

Methods inherited from class java.lang.Object

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

Method Detail

withName

public static Keyword.Builder withName(String name)

Create a new Keyword.Builder for a keyword with a given name

Parameters:

name - the name

Returns:

the newly created builder

getName

public String getName()

getSyntaxChecker

public SyntaxChecker getSyntaxChecker()

getValidatorClass

public Class<? extends KeywordValidator> getValidatorClass()