org.bitbucket.cowwoc.requirements.spi

Interface ObjectRequirementsSpi<S extends ObjectRequirementsSpi<S,T>,T>

Type Parameters:

S - the type of the non-SPI interface extending this interface

T - the type of the parameter

All Known Subinterfaces:

BigDecimalPrecisionRequirements, BigDecimalRequirements, BigDecimalScaleRequirements, ClassRequirements<T>, CollectionRequirements<E>, CollectionRequirementsSpi<S,E>, CollectionSizeRequirements, ComparableRequirements<T>, ComparableRequirementsSpi<S,T>, MapRequirements<K,V>, MapSizeRequirements, NumberRequirements<T>, NumberRequirementsSpi<S,T>, ObjectRequirements<T>, OptionalRequirements, PathRequirements, PrimitiveIntegerRequirementsSpi<S>, StringLengthRequirements, StringRequirements, UriRequirements

public interface ObjectRequirementsSpi<S extends ObjectRequirementsSpi<S,T>,T>

Verifies requirements of an Object parameter.

Author:

Gili Tzabari

Method Summary

Modifier and Type	Method and Description
S	isEqualTo(T value) Ensures that the parameter is equal to a value.
S	isEqualTo(T value, String name) Ensures that the parameter is equal to a variable.
S	isInstanceOf(Class<?> type) Ensures that the parameter is an instance of a class.
S	isNotEqualTo(T value) Ensures that the parameter is not equal to a value.
S	isNotEqualTo(T value, String name) Ensures that the parameter is not equal to a variable.
S	isNotNull() Ensures that the parameter is not null.
S	isNull() Ensures that the parameter is null.
S	withContext(Map<String,Object> context) Supplies additional key-value pairs to output if a requirement is not met.
S	withException(Class<? extends RuntimeException> exception) Overrides the type of exception that will get thrown if a requirement fails.

Method Detail

withException

S withException(Class<? extends RuntimeException> exception)

Overrides the type of exception that will get thrown if a requirement fails.

Parameters:

exception - the type of exception to throw, null to disable the override

Returns:

this

withContext

@Beta
S withContext(Map<String,Object> context)
              throws NullPointerException

Supplies additional key-value pairs to output if a requirement is not met.

Parameters:

context - a map of key-value pairs

Returns:

this

Throws:

NullPointerException - if context is null

isEqualTo

S isEqualTo(T value)
     throws IllegalArgumentException

Ensures that the parameter is equal to a value.

Parameters:

value - the value to compare to

Returns:

this

Throws:

IllegalArgumentException - if parameter is not equal to value

isEqualTo

S isEqualTo(T value,
            String name)
     throws NullPointerException,
            IllegalArgumentException

Ensures that the parameter is equal to a variable.

Parameters:

value - the value to compare to

name - the name of the variable

Returns:

this

Throws:

NullPointerException - if name is null

IllegalArgumentException - if parameter is not equal to the variable; if name is empty

isNotEqualTo

S isNotEqualTo(T value)
        throws IllegalArgumentException

Ensures that the parameter is not equal to a value.

Parameters:

value - the value to compare to

Returns:

this

Throws:

IllegalArgumentException - if parameter is equal to value

isNotEqualTo

S isNotEqualTo(T value,
               String name)
        throws NullPointerException,
               IllegalArgumentException

Ensures that the parameter is not equal to a variable.

Parameters:

value - the value to compare to

name - the name of the variable

Returns:

this

Throws:

NullPointerException - if name is null

IllegalArgumentException - if parameter is equal to the variable; if name is empty

isInstanceOf

S isInstanceOf(Class<?> type)
        throws NullPointerException,
               IllegalArgumentException

Ensures that the parameter is an instance of a class.

Parameters:

type - the class to compare to

Returns:

this

Throws:

NullPointerException - if type are null

IllegalArgumentException - if parameter is not an instance of type

isNull

S isNull()
  throws IllegalArgumentException

Ensures that the parameter is null.

Returns:

this

Throws:

IllegalArgumentException - if parameter is not null

isNotNull

S isNotNull()
     throws NullPointerException

Ensures that the parameter is not null.

Returns:

this

Throws:

NullPointerException - if parameter is null