org.bitbucket.cowwoc.requirements

Class Assertions

java.lang.Object

org.bitbucket.cowwoc.requirements.Assertions

public final class Assertions
extends Object

Verifies requirements of a parameter if assertions are enabled; otherwise, does nothing.

All verifier implementations must be immutable and final.

Author:

Gili Tzabari

Constructor Summary

Constructors

Constructor and Description
Assertions(boolean enabled) Creates a new assertion.

Method Summary

Modifier and Type	Method and Description
boolean	isEnabled()
BigDecimalRequirements	requireThat(BigDecimal parameter, String name) Same as Requirements.requireThat(BigDecimal, String) but does nothing if assertions are disabled.
<T> ClassRequirements<T>	requireThat(Class<T> parameter, String name) Same as Requirements.requireThat(Class, String) but does nothing if assertions are disabled.
<E> CollectionRequirements<E>	requireThat(Collection<E> parameter, String name) Same as Requirements.requireThat(Collection, String) but does nothing if assertions are disabled.
<K,V> MapRequirements<K,V>	requireThat(Map<K,V> parameter, String name) Same as Requirements.requireThat(Map, String) but does nothing if assertions are disabled.
ObjectRequirements<Object>	requireThat(Object parameter, String name) Same as Requirements.requireThat(Object, String) but does nothing if assertions are disabled.
OptionalRequirements	requireThat(Optional<?> parameter, String name) Same as Requirements.requireThat(Optional, String) but does nothing if assertions are disabled.
PathRequirements	requireThat(Path parameter, String name) Same as Requirements.requireThat(Path, String) but does nothing if assertions are disabled.
StringRequirements	requireThat(String parameter, String name) Same as Requirements.requireThat(String, String) but does nothing if assertions are disabled.
<T extends Comparable<? super T>> ComparableRequirements<T>	requireThat(T parameter, String name) Same as Requirements.requireThat(Comparable, String) but does nothing if assertions are disabled.
<T extends Number & Comparable<? super T>> NumberRequirements<T>	requireThat(T parameter, String name) Same as Requirements.requireThat(Number, String) but does nothing if assertions are disabled.
UriRequirements	requireThat(URI parameter, String name) Same as Requirements.requireThat(URI, String) but does nothing if assertions are disabled.

Methods inherited from class java.lang.Object

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

Constructor Detail

Assertions

public Assertions(boolean enabled)

Creates a new assertion.

To look up whether assertions are enabled for a particular class, invoke:

boolean assertionsEnabled = false;
assert (assertionsEnabled = true);

from within the class in question.

Parameters:

enabled - true if assertions are enabled for the class whose requirements are being verified

Method Detail

isEnabled

public boolean isEnabled()

Returns:

true if assertions are enabled

requireThat

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

Same as Requirements.requireThat(Object, String) but does nothing if assertions are disabled.

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

Same as Requirements.requireThat(Collection, String) but does nothing if assertions are disabled.

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

Same as Requirements.requireThat(Comparable, String) but does nothing if assertions are disabled.

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 <T extends Number & Comparable<? super T>> NumberRequirements<T> requireThat(T parameter,
                                                                                    String name)
                                                                             throws NullPointerException,
                                                                                    IllegalArgumentException

Same as Requirements.requireThat(Number, String) but does nothing if assertions are disabled.

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 BigDecimalRequirements requireThat(BigDecimal parameter,
                                          String name)
                                   throws NullPointerException,
                                          IllegalArgumentException

Same as Requirements.requireThat(BigDecimal, String) but does nothing if assertions are disabled.

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

Same as Requirements.requireThat(Map, String) but does nothing if assertions are disabled.

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

Same as Requirements.requireThat(Path, String) but does nothing if assertions are disabled.

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

Same as Requirements.requireThat(String, String) but does nothing if assertions are disabled.

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

Same as Requirements.requireThat(URI, String) but does nothing if assertions are disabled.

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

Same as Requirements.requireThat(Class, String) but does nothing if assertions are disabled.

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

Same as Requirements.requireThat(Optional, String) but does nothing if assertions are disabled.

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