Interface OptionalValidator<T>

Type Parameters:

T - the type of object in the optional

All Superinterfaces:

ObjectComponent<OptionalValidator<T>, Optional<T>>, ValidatorComponent<OptionalValidator<T>, Optional<T>>

public interface OptionalValidator<T>
extends ValidatorComponent<OptionalValidator<T>, Optional<T>>, ObjectComponent<OptionalValidator<T>, Optional<T>>

Validates the state of an Optional.

Method Summary

Modifier and Type	Method	Description
OptionalValidator<T>	contains(Object expected)	Ensures that the optional contains a value.
OptionalValidator<T>	contains(Object expected, String name)	Ensures that the optional contains expected.
OptionalValidator<T>	isEmpty()	Ensures that the optional is absent.
OptionalValidator<T>	isPresent()	Ensures that the optional contains a value.

Methods declared in interface ObjectComponent

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

Methods declared in interface ValidatorComponent

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

Method Details

isPresent

OptionalValidator<T> isPresent()

Ensures that the optional contains a value.

Returns:

this

Throws:

NullPointerException - if the value is null

IllegalArgumentException - if the optional is empty

isEmpty

OptionalValidator<T> isEmpty()

Ensures that the optional is absent.

Returns:

this

Throws:

NullPointerException - if the value is null

IllegalArgumentException - if the optional contains a value

contains

OptionalValidator<T> contains(Object expected)

Ensures that the optional contains a value.

Parameters:

expected - the expected value; null matches an empty optional

Returns:

this

Throws:

NullPointerException - if the value is null

IllegalArgumentException - if the optional does not contain expected

contains

OptionalValidator<T> contains(Object expected,
 String name)

Ensures that the optional contains expected.

Parameters:

expected - the expected value (null matches an empty optional)

name - the name of the expected value

Returns:

this

Throws:

NullPointerException - if the value or name are null

IllegalArgumentException - if:

• name is empty
• name contains whitespace
• name is already in use by the value being validated or the validator context
• the optional does not contain expected