org.bitbucket.cowwoc.requirements

Class Requirements

java.lang.Object

org.bitbucket.cowwoc.requirements.Requirements

public final class Requirements
extends Object

Verifies the requirements of a parameter.

This convenience class constructs a RequirementVerifier or AssertionVerifier with a default configuration. The class's assertion status determines whether AssertionVerifier is enabled or not.

Author:

Gili Tzabari

Method Summary

Modifier and Type	Method and Description
static boolean	assertionsAreEnabled()
static BigDecimalRequirements	assertThat(BigDecimal parameter, String name) Same as requireThat(BigDecimal, String) but does nothing if assertions are disabled for this class.
static <T> ClassRequirements<T>	assertThat(Class<T> parameter, String name) Same as requireThat(Class, String) but does nothing if assertions are disabled for this class.
static <E> CollectionRequirements<E>	assertThat(Collection<E> parameter, String name) Same as requireThat(Collection, String) but does nothing if assertions are disabled for this class.
static DoubleRequirements	assertThat(Double parameter, String name) Same as requireThat(Double, String) but does nothing if assertions are disabled for this class.
static <K,V> MapRequirements<K,V>	assertThat(Map<K,V> parameter, String name) Same as requireThat(Map, String) but does nothing if assertions are disabled for this class.
static ObjectRequirements<Object>	assertThat(Object parameter, String name) Same as requireThat(Object, String) but does nothing if assertions are disabled for this class.
static OptionalRequirements	assertThat(Optional<?> parameter, String name) Same as requireThat(Optional, String) but does nothing if assertions are disabled for this class.
static PathRequirements	assertThat(Path parameter, String name) Same as requireThat(Path, String) but does nothing if assertions are disabled for this class.
static StringRequirements	assertThat(String parameter, String name) Same as requireThat(String, String) but does nothing if assertions are disabled for this class.
static <T extends Comparable<? super T>> ComparableRequirements<T>	assertThat(T parameter, String name) Same as requireThat(Comparable, String) but does nothing if assertions are disabled for this class.
static <T extends Number & Comparable<? super T>> NumberRequirements<T>	assertThat(T parameter, String name) Same as requireThat(Number, String) but does nothing if assertions are disabled for this class.
static UriRequirements	assertThat(URI parameter, String name) Same as requireThat(URI, String) but does nothing if assertions are disabled for this class.
static BigDecimalRequirements	requireThat(BigDecimal parameter, String name) Verifies requirements of a BigDecimal.
static <T> ClassRequirements<T>	requireThat(Class<T> parameter, String name) Verifies requirements of a Class.
static <E> CollectionRequirements<E>	requireThat(Collection<E> parameter, String name) Verifies requirements of a Collection.
static DoubleRequirements	requireThat(Double parameter, String name) Verifies requirements of a Double.
static <K,V> MapRequirements<K,V>	requireThat(Map<K,V> parameter, String name) Verifies requirements of a Map.
static ObjectRequirements<Object>	requireThat(Object parameter, String name) Verifies requirements of an Object.
static OptionalRequirements	requireThat(Optional<?> parameter, String name) Verifies requirements of an Optional.
static PathRequirements	requireThat(Path parameter, String name) Verifies requirements of a Path.
static StringRequirements	requireThat(String parameter, String name) Verifies requirements of a String.
static <T extends Comparable<? super T>> ComparableRequirements<T>	requireThat(T parameter, String name) Verifies requirements of a Comparable.
static <T extends Number & Comparable<? super T>> NumberRequirements<T>	requireThat(T parameter, String name) Verifies requirements of a Number.
static UriRequirements	requireThat(URI parameter, String name) Verifies requirements of a Uri.

Methods inherited from class java.lang.Object

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

Method Detail

assertionsAreEnabled

@Beta
public static boolean assertionsAreEnabled()

Returns:

true if assertions are enabled for this class

requireThat

public static 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

assertThat

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

Same as requireThat(Object, String) but does nothing if assertions are disabled for this 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 static <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

assertThat

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

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

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 static <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

assertThat

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

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

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 static <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

assertThat

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

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

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 static 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

assertThat

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

Same as requireThat(Double, String) but does nothing if assertions are disabled for this 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 static 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

assertThat

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

Same as requireThat(BigDecimal, String) but does nothing if assertions are disabled for this 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 static <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

assertThat

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

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

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 static 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

assertThat

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

Same as requireThat(Path, String) but does nothing if assertions are disabled for this 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 static 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

assertThat

public static StringRequirements assertThat(String parameter,
                                            String name)
                                     throws NullPointerException,
                                            IllegalArgumentException

Same as requireThat(String, String) but does nothing if assertions are disabled for this 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 static 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

assertThat

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

Same as requireThat(URI, String) but does nothing if assertions are disabled for this 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 static <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

assertThat

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

Same as requireThat(Class, String) but does nothing if assertions are disabled for this 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 static 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

assertThat

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

Same as requireThat(Optional, String) but does nothing if assertions are disabled for this 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