org.bitbucket.cowwoc.requirements

Interface Verifier

All Known Subinterfaces:

BigDecimalPrecisionRequirements, BigDecimalRequirements, BigDecimalScaleRequirements, ClassRequirements<T>, CollectionRequirements<E>, org.bitbucket.cowwoc.requirements.spi.CollectionRequirementsSpi<S,E>, CollectionSizeRequirements, ComparableRequirements<T>, org.bitbucket.cowwoc.requirements.spi.ComparableRequirementsSpi<S,T>, DoubleRequirements, MapRequirements<K,V>, MapSizeRequirements, NumberRequirements<T>, org.bitbucket.cowwoc.requirements.spi.NumberRequirementsSpi<S,T>, ObjectRequirements<T>, org.bitbucket.cowwoc.requirements.spi.ObjectRequirementsSpi<S,T>, OptionalRequirements, PathRequirements, org.bitbucket.cowwoc.requirements.spi.PrimitiveIntegerRequirementsSpi<S>, StringLengthRequirements, StringRequirements, UriRequirements

All Known Implementing Classes:

AssertionVerifier, DoubleRequirementsImpl, RequirementVerifier

public interface Verifier

Behavior common to all verifiers.

All implementations must be immutable and final.

Since:

2.0.3

Author:

Gili Tzabari

Method Summary

Modifier and Type	Method and Description
Verifier	addContext(String key, Object value) Appends contextual information to the exception message.
Verifier	withContext(List<Map.Entry<String,Object>> context) Sets the contextual information to append to the exception message.
Verifier	withException(Class<? extends RuntimeException> exception) Overrides the type of exception that will get thrown if a requirement fails.

Method Detail

withException

Verifier withException(Class<? extends RuntimeException> exception)

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

The exception class must define the following constructors:

<init>(String message)
<init>(String message, Throwable cause)

Parameters:

exception - the type of exception to throw, null to throw the default exception type

Returns:

a verifier with the specified exception override

addContext

@Beta
Verifier addContext(String key,
                           Object value)
                    throws NullPointerException

Appends contextual information to the exception message.

Parameters:

key - a key

value - a value

Returns:

a verifier with the specified context

Throws:

NullPointerException - if key is null

withContext

@Beta
Verifier withContext(List<Map.Entry<String,Object>> context)
                     throws NullPointerException

Sets the contextual information to append to the exception message.

Parameters:

context - the contextual information

Returns:

a verifier with the specified context

Throws:

NullPointerException - if context is null