org.bitbucket.cowwoc.requirements

Class RequirementVerifier

java.lang.Object

org.bitbucket.cowwoc.requirements.RequirementVerifier

All Implemented Interfaces:

Verifier

public final class RequirementVerifier
extends Object
implements Verifier

Verifies requirements of a parameter.

Unlike Requirements, instances of this class can be configured prior to initiating verification. Doing so causes the same configuration to get reused across runs.

Since:

2.0.3

Author:

Gili Tzabari

Constructor Summary

Constructors

Constructor and Description
RequirementVerifier() Creates a new requirement verifier.

Method Summary

Modifier and Type	Method and Description
RequirementVerifier	addContext(String key, Object value) Appends contextual information to the exception message.
BigDecimalRequirements	requireThat(BigDecimal parameter, String name) Verifies requirements of a BigDecimal.
<T> ClassRequirements<T>	requireThat(Class<T> parameter, String name) Verifies requirements of a Class.
<E> CollectionRequirements<E>	requireThat(Collection<E> parameter, String name) Verifies requirements of a Collection.
DoubleRequirements	requireThat(Double parameter, String name) Verifies requirements of a Double.
<K,V> MapRequirements<K,V>	requireThat(Map<K,V> parameter, String name) Verifies requirements of a Map.
ObjectRequirements<Object>	requireThat(Object parameter, String name) Verifies requirements of an Object.
OptionalRequirements	requireThat(Optional<?> parameter, String name) Verifies requirements of an Optional.
PathRequirements	requireThat(Path parameter, String name) Verifies requirements of a Path.
StringRequirements	requireThat(String parameter, String name) Verifies requirements of a String.
<T extends Comparable<? super T>> ComparableRequirements<T>	requireThat(T parameter, String name) Verifies requirements of a Comparable.
<T extends Number & Comparable<? super T>> NumberRequirements<T>	requireThat(T parameter, String name) Verifies requirements of a Number.
UriRequirements	requireThat(URI parameter, String name) Verifies requirements of a Uri.
RequirementVerifier	withContext(List<Map.Entry<String,Object>> context) Sets the contextual information to append to the exception message.
RequirementVerifier	withException(Class<? extends RuntimeException> exception) Overrides the type of exception that will get thrown if a requirement fails.

Methods inherited from class java.lang.Object

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

Constructor Detail

RequirementVerifier

public RequirementVerifier()

Creates a new requirement verifier.

Method Detail

withException

public RequirementVerifier withException(Class<? extends RuntimeException> exception)

Description copied from interface: Verifier

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)

Specified by:

withException in interface Verifier

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
public RequirementVerifier addContext(String key,
                                             Object value)
                                      throws NullPointerException

Description copied from interface: Verifier

Appends contextual information to the exception message.

Specified by:

addContext in interface Verifier

Parameters:

key - a key

value - a value

Returns:

a verifier with the specified context

Throws:

NullPointerException - if key is null

withContext

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

Description copied from interface: Verifier

Sets the contextual information to append to the exception message.

Specified by:

withContext in interface Verifier

Parameters:

context - the contextual information

Returns:

a verifier with the specified context

Throws:

NullPointerException - if context is null

requireThat

public ObjectRequirements<Object> requireThat(Object parameter,
                                              String name)
                                       throws NullPointerException,
                                              IllegalArgumentException

Verifies requirements of an Object.

Parameters:

parameter - the value of the parameter

name - the name of the parameter

Returns:

Requirements for the parameter

Throws:

NullPointerException - if name is null

IllegalArgumentException - if name is empty

requireThat

public <E> CollectionRequirements<E> requireThat(Collection<E> parameter,
                                                 String name)
                                          throws NullPointerException,
                                                 IllegalArgumentException

Verifies requirements of a Collection.

Type Parameters:

E - the type of element in the collection

Parameters:

parameter - the value of the parameter

name - the name of the parameter

Returns:

Requirements for the parameter

Throws:

NullPointerException - if name is null

IllegalArgumentException - if name is empty

requireThat

public <T extends Comparable<? super T>> ComparableRequirements<T> requireThat(T parameter,
                                                                               String name)
                                                                        throws NullPointerException,
                                                                               IllegalArgumentException

Verifies requirements of a Comparable.

Type Parameters:

T - the type of objects that the parameter may be compared to

Parameters:

parameter - the value of the parameter

name - the name of the parameter

Returns:

Requirements for the parameter

Throws:

NullPointerException - if name is null

IllegalArgumentException - if name is empty

requireThat

public <T extends Number & Comparable<? super T>> NumberRequirements<T> requireThat(T parameter,
                                                                                    String name)
                                                                             throws NullPointerException,
                                                                                    IllegalArgumentException

Verifies requirements of a Number.

Type Parameters:

T - the type of the number

Parameters:

parameter - the value of the parameter

name - the name of the parameter

Returns:

Requirements for the parameter

Throws:

NullPointerException - if name is null

IllegalArgumentException - if name is empty

requireThat

public DoubleRequirements requireThat(Double parameter,
                                      String name)
                               throws NullPointerException,
                                      IllegalArgumentException

Verifies requirements of a Double.

Parameters:

parameter - the value of the parameter

name - the name of the parameter

Returns:

Requirements for the parameter

Throws:

NullPointerException - if name is null

IllegalArgumentException - if name is empty

requireThat

public BigDecimalRequirements requireThat(BigDecimal parameter,
                                          String name)
                                   throws NullPointerException,
                                          IllegalArgumentException

Verifies requirements of a BigDecimal.

Parameters:

parameter - the value of the parameter

name - the name of the parameter

Returns:

Requirements for the parameter

Throws:

NullPointerException - if name is null

IllegalArgumentException - if name is empty

requireThat

public <K,V> MapRequirements<K,V> requireThat(Map<K,V> parameter,
                                              String name)
                                       throws NullPointerException,
                                              IllegalArgumentException

Verifies requirements of a Map.

Type Parameters:

K - the type of key in the map

V - the type of value in the map

Parameters:

parameter - the value of the parameter

name - the name of the parameter

Returns:

Requirements for the parameter

Throws:

NullPointerException - if name is null

IllegalArgumentException - if name is empty

requireThat

public PathRequirements requireThat(Path parameter,
                                    String name)
                             throws NullPointerException,
                                    IllegalArgumentException

Verifies requirements of a Path.

Parameters:

parameter - the value of the parameter

name - the name of the parameter

Returns:

Requirements for the parameter

Throws:

NullPointerException - if name is null

IllegalArgumentException - if name is empty

requireThat

public StringRequirements requireThat(String parameter,
                                      String name)
                               throws NullPointerException,
                                      IllegalArgumentException

Verifies requirements of a String.

Parameters:

parameter - the value of the parameter

name - the name of the parameter

Returns:

Requirements for the parameter

Throws:

NullPointerException - if name is null

IllegalArgumentException - if name is empty

requireThat

public UriRequirements requireThat(URI parameter,
                                   String name)
                            throws NullPointerException,
                                   IllegalArgumentException

Verifies requirements of a Uri.

Parameters:

parameter - the value of the parameter

name - the name of the parameter

Returns:

Requirements for the parameter

Throws:

NullPointerException - if name is null

IllegalArgumentException - if name is empty

requireThat

public <T> ClassRequirements<T> requireThat(Class<T> parameter,
                                            String name)
                                     throws NullPointerException,
                                            IllegalArgumentException

Verifies requirements of a Class.

Type Parameters:

T - the type of class

Parameters:

parameter - the value of the parameter

name - the name of the parameter

Returns:

Requirements for the parameter

Throws:

NullPointerException - if name is null

IllegalArgumentException - if name is empty

requireThat

public OptionalRequirements requireThat(Optional<?> parameter,
                                        String name)
                                 throws NullPointerException,
                                        IllegalArgumentException

Verifies requirements of an Optional.

Parameters:

parameter - the value of the parameter

name - the name of the parameter

Returns:

Requirements for the parameter

Throws:

NullPointerException - if name is null

IllegalArgumentException - if name is empty