org.eel.kitchen.jsonschema.keyword

Class NumericKeywordValidator

java.lang.Object

org.eel.kitchen.jsonschema.keyword.KeywordValidator

org.eel.kitchen.jsonschema.keyword.NumericKeywordValidator

Direct Known Subclasses:

DivisibleByKeywordValidator, MaximumKeywordValidator, MinimumKeywordValidator

public abstract class NumericKeywordValidator
extends KeywordValidator

Base class for numeric instances validators

We separate validation in two: if both the keyword value and instance value are integers which fit into a long, we use that (for performance reasons). If one of them doesn't, then we use BigDecimal instead (for accuracy reasons).

This means that extending this validator will require you to implement two methods: validateLong(ValidationReport, JsonNode) and validateDecimal(ValidationReport, JsonNode).

You will note that these two methods take a JsonNode as an argument. Use the following methods to convert these to the appropriate types:

• long: JsonNode.longValue();
• BigDecimal: JsonNode.decimalValue().

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	isLong Does the keyword value fits into a long?
protected JsonNode	number The keyword value

Fields inherited from class org.eel.kitchen.jsonschema.keyword.KeywordValidator

keyword, nodeFactory

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NumericKeywordValidator(String keyword, JsonNode schema) Protected constructor

Method Summary

Methods

Modifier and Type	Method and Description
String	toString()
void	validate(ValidationContext context, ValidationReport report, JsonNode instance) Main validation method
protected abstract void	validateDecimal(ValidationReport report, JsonNode instance) Method to be implemented by a numeric validator if either of the keyword value or instance value do not fit into a long
protected abstract void	validateLong(ValidationReport report, JsonNode instance) Method to be implemented by a numeric validator if both the keyword value and instance value fit into a long
private static boolean	valueIsLong(JsonNode node) Test whether a numeric instance is a long

Methods inherited from class org.eel.kitchen.jsonschema.keyword.KeywordValidator

newMsg, validateInstance

Methods inherited from class java.lang.Object

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

Field Detail

number

protected final JsonNode number

The keyword value

isLong

private final boolean isLong

Does the keyword value fits into a long?

Constructor Detail

NumericKeywordValidator

protected NumericKeywordValidator(String keyword,
                       JsonNode schema)

Protected constructor

Parameters:

keyword - the keyword

schema - the schema

Method Detail

validateLong

protected abstract void validateLong(ValidationReport report,
                JsonNode instance)

Method to be implemented by a numeric validator if both the keyword value and instance value fit into a long

Parameters:

report - the validation report

instance - the instance to validate

validateDecimal

protected abstract void validateDecimal(ValidationReport report,
                   JsonNode instance)

Method to be implemented by a numeric validator if either of the keyword value or instance value do not fit into a long

Parameters:

report - the validation report

instance - the instance to validate

validate

public final void validate(ValidationContext context,
            ValidationReport report,
            JsonNode instance)

Main validation method

This is where the test for long is done on both the keyword value and instance value. According to the result, this method will then call either validateLong(ValidationReport, JsonNode) or validateDecimal(ValidationReport, JsonNode)

Specified by:

validate in class KeywordValidator

Parameters:

context - the context

report - the validation report

instance - the instance to validate

valueIsLong

private static boolean valueIsLong(JsonNode node)

Test whether a numeric instance is a long

We use both a test on the instance type and Jackson's JsonNode.canConvertToLong(). The first test is needed since the latter method will also return true if the value is a decimal which integral part fits into a long, and we don't want that.

Parameters:

node - the node to test

Returns:

true if both conditions are true

toString

public String toString()

Specified by:

toString in class KeywordValidator