org.eel.kitchen.jsonschema.format

Class FormatSpecifier

java.lang.Object

org.eel.kitchen.jsonschema.format.FormatSpecifier

Direct Known Subclasses:

AbstractDateFormatSpecifier, EmailFormatSpecifier, HostnameFormatSpecifier, IPV4FormatSpecifier, IPV6FormatSpecifier, RegexFormatSpecifier, URIFormatSpecifier

public abstract class FormatSpecifier
extends Object

Base class for a format specifier

The format keyword always takes a string as an argument, and this string is called a "specifier". The draft defines specifiers for recognizing URIs, phone numbers, different date formats, and so on -- and even CSS 2.1 colors and styles (not supported).

One important thing to remember is that a specifier will only validate a given subset of JSON instance types (for instance, uri only validates string instances). In the event that the instane type is not of the validated types, validation succeeds.

The spec allows for custom specifiers to be added. This implementation, however, does not support it.

Field Summary

Fields

Modifier and Type	Field and Description
private EnumSet<NodeType>	typeSet JSON instance types which this specifier can validate

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FormatSpecifier(NodeType first, NodeType... other) Protected constructor

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	checkValue(String fmt, ValidationContext ctx, ValidationReport report, JsonNode value) Abstract method implemented by all specifiers
protected static ValidationMessage.Builder	newMsg(String fmt)
void	validate(String fmt, ValidationContext ctx, ValidationReport report, JsonNode value) Main validation function

Methods inherited from class java.lang.Object

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

Field Detail

typeSet

private final EnumSet<NodeType> typeSet

JSON instance types which this specifier can validate

Constructor Detail

FormatSpecifier

protected FormatSpecifier(NodeType first,
               NodeType... other)

Protected constructor

Its arguments are the node types recognized by the specifier. Only one specifier recognizes more than one type: utc-millisec (it can validate both numbers and integers).

Parameters:

first - first type

other - other types, if any

Method Detail

validate

public final void validate(String fmt,
            ValidationContext ctx,
            ValidationReport report,
            JsonNode value)

Main validation function

This function only checks whether the value is of a type recognized by this specifier. If so, it calls checkValue(String, ValidationContext, ValidationReport, JsonNode).

The message template passed as an argument will have been pre-filled with the keyword (format, the specifier name and the domain (ValidationDomain.VALIDATION).

Parameters:

fmt - the format specifier name

ctx - the validation context

report - the validation report

value - the value to validate

checkValue

public abstract void checkValue(String fmt,
              ValidationContext ctx,
              ValidationReport report,
              JsonNode value)

Abstract method implemented by all specifiers

It is only called if the value type is one expected by the specifier, see validate(String, ValidationContext, ValidationReport, JsonNode).

Parameters:

fmt - the format specifier name

ctx - the validation context

report - the validation report

value - the value to validate

newMsg

protected static ValidationMessage.Builder newMsg(String fmt)