com.github.fge.jsonschema.format

Class FormatAttribute

java.lang.Object

com.github.fge.jsonschema.format.FormatAttribute

Direct Known Subclasses:

AbstractDateFormatAttribute, EmailFormatAttribute, HostnameFormatAttribute, IPV4FormatAttribute, IPV6FormatAttribute, MediaTypeFormatAttribute, PhoneNumberFormatAttribute, RegexFormatAttribute, UnixEpochFormatAttribute, URIFormatAttribute

public abstract class FormatAttribute
extends Object

Base class for a format attribute

The format keyword always takes a string as an argument, and this string is called a "attribute". See FormatAttributes for the list of supported attributes.

One important thing to remember is that a attribute 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.

JSON Schema specifications allow for custom attributes to be added. This implementation supports it.

Final note: even though you may register format attributes to validate container instances, drafts also explicitly says that you should not do so.

See Also:

KeywordRegistry

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	checkValue(String fmt, ValidationReport report, JsonNode value) Abstract method implemented by all attributes
protected static Message.Builder	newMsg(String fmt)
void	validate(String fmt, 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

Constructor Detail

FormatAttribute

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

Protected constructor

Its arguments are the node types recognized by the attribute. Only one attribute 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,
            ValidationReport report,
            JsonNode value)

Main validation function

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

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

Parameters:

fmt - the format attribute name

report - the validation report

value - the value to validate

checkValue

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

Abstract method implemented by all attributes

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

Parameters:

fmt - the format attribute name

report - the validation report

value - the value to validate

newMsg

protected static Message.Builder newMsg(String fmt)