Module com.github.cowwoc.requirements10.jackson

Package com.github.cowwoc.requirements10.jackson.validator

Interface JsonNodeValidator<T extends JsonNode>

Type Parameters:

T - the type of the JsonNode

All Superinterfaces:

ObjectComponent<JsonNodeValidator<T>,T>, ValidatorComponent<JsonNodeValidator<T>,T>

public interface JsonNodeValidator<T extends JsonNode>
extends ValidatorComponent<JsonNodeValidator<T>,T>, ObjectComponent<JsonNodeValidator<T>,T>

Validates the state of a JsonNode.

Method Summary

Modifier and Type	Method	Description
JsonNodeValidator<ArrayNode>	isArray()	Ensures that the node contains an array.
JsonNodeValidator<DecimalNode>	isBigDecimal()	Ensures that the node contains a BigDecimal.
JsonNodeValidator<BigIntegerNode>	isBigInteger()	Ensures that the node contains a BigInteger.
JsonNodeValidator<BooleanNode>	isBoolean()	Ensures that the node contains a Boolean.
JsonNodeValidator<ContainerNode<?>>	isContainer()	Ensures that the node contains an array or object.
JsonNodeValidator<NumericNode>	isFloatingPointNumber()	Ensures that the node contains a float or double.
JsonNodeValidator<NumericNode>	isIntegralNumber()	Ensures that the node contains a byte, short, int or long.
JsonNodeValidator<MissingNode>	isMissing()	Ensures that the value references a missing node.
JsonNodeValidator<NumericNode>	isNumber()	Ensures that the node contains a Number.
JsonNodeValidator<ObjectNode>	isObject()	Ensures that the node contains an object.
JsonNodeValidator<TextNode>	isString()	Ensures that the node contains a String.
JsonNodeValidator<ValueNode>	isValue()	Ensures that the node contains a binary value, boolean, null, number or string.
JsonNodeValidator<JsonNode>	property(String name)	Returns a validator for the node's property.
PrimitiveUnsignedIntegerValidator	size()	Returns a validator over the node's size.

Methods declared in interface com.github.cowwoc.requirements10.java.validator.component.ObjectComponent

getValue, isEqualTo, isEqualTo, isInstanceOf, isInstanceOf, isNotEqualTo, isNotEqualTo, isNotInstanceOf, isNotInstanceOf, isNotNull, isNull, isReferenceEqualTo, isReferenceNotEqualTo

Methods declared in interface com.github.cowwoc.requirements10.java.validator.component.ValidatorComponent

and, elseGetFailures, elseThrow, getContext, getContextAsString, getName, getValueOrDefault, validationFailed, withContext

Method Details

property

JsonNodeValidator<JsonNode> property(String name)

Returns a validator for the node's property.

Parameters:

name - the name of a property

Returns:

a validator for the property

Throws:

NullPointerException - if the value or name are null

IllegalArgumentException - if the node does not contain the property

size

PrimitiveUnsignedIntegerValidator size()

Returns a validator over the node's size.

Returns:

a validator over the node's size

Throws:

NullPointerException - if the value is null

isNumber

JsonNodeValidator<NumericNode> isNumber()

Ensures that the node contains a Number.

Returns:

this

Throws:

NullPointerException - if the value is null

IllegalArgumentException - if the node does not contain a number

isIntegralNumber

JsonNodeValidator<NumericNode> isIntegralNumber()

Ensures that the node contains a byte, short, int or long.

Returns:

this

Throws:

NullPointerException - if the value is null

IllegalArgumentException - if the node does not contain an integral number

isFloatingPointNumber

JsonNodeValidator<NumericNode> isFloatingPointNumber()

Ensures that the node contains a float or double.

Returns:

this

Throws:

NullPointerException - if the value is null

IllegalArgumentException - if the node does not contain a decimal number

isBigInteger

JsonNodeValidator<BigIntegerNode> isBigInteger()

Ensures that the node contains a BigInteger.

Returns:

this

Throws:

NullPointerException - if the value is null

IllegalArgumentException - if the node does not contain a BigInteger

isBigDecimal

JsonNodeValidator<DecimalNode> isBigDecimal()

Ensures that the node contains a BigDecimal.

Returns:

this

Throws:

NullPointerException - if the value is null

IllegalArgumentException - if the node does not contain a BigDecimal

isMissing

JsonNodeValidator<MissingNode> isMissing()

Ensures that the value references a missing node.

Returns:

this

Throws:

NullPointerException - if the value is null

IllegalArgumentException - if the value does not represent a missing node

See Also:

• TreeNode.isMissingNode()

isValue

JsonNodeValidator<ValueNode> isValue()

Ensures that the node contains a binary value, boolean, null, number or string.

Returns:

this

Throws:

NullPointerException - if the value is null

IllegalArgumentException - if the value is not a binary value, boolean, null, number or string

See Also:

• TreeNode.isValueNode()

isContainer

JsonNodeValidator<ContainerNode<?>> isContainer()

Ensures that the node contains an array or object.

Returns:

this

Throws:

NullPointerException - if the value is null

IllegalArgumentException - if the value is a "missing" or a value node

See Also:

• TreeNode.isContainerNode()

isArray

JsonNodeValidator<ArrayNode> isArray()

Ensures that the node contains an array.

Returns:

this

Throws:

NullPointerException - if the value is null

IllegalArgumentException - if the value is not an array

See Also:

• TreeNode.isArray()

isObject

JsonNodeValidator<ObjectNode> isObject()

Ensures that the node contains an object.

Returns:

this

Throws:

NullPointerException - if the value is null

IllegalArgumentException - if the value is not an object

See Also:

• TreeNode.isObject()

isString

JsonNodeValidator<TextNode> isString()

Ensures that the node contains a String.

Returns:

this

Throws:

NullPointerException - if the value is null

IllegalArgumentException - if the value is not a String

See Also:

• JsonNode.isTextual()

isBoolean

JsonNodeValidator<BooleanNode> isBoolean()

Ensures that the node contains a Boolean.

Returns:

this

Throws:

NullPointerException - if the value is null

IllegalArgumentException - if the value is not a Boolean

See Also:

• JsonNode.isBoolean()