org.nerd4j.utils.lang

Class Require

java.lang.Object

org.nerd4j.utils.lang.Require

public class Require
extends Object

Assertion utility class that assists in validating arguments. Is inspired by the Objects.requireNonNull(Object,String) approach but provides null-safe operations for the most common checks over Objects, Strings, Collections, Maps, arrays and objects that implement the Emptily interface.

This class is designed primarily for doing parameter validation in methods and constructors, like the following:

 public MyClass( int id, Foo foo, String bar )
 {
    this.id  = Require.trueFor( id, id > 0, "id must be positive" );
    this.foo = Require.nonNull( foo, "foo cannot be null" );
    this.val = Require.nonBlank( val, "val cannot be blank" );
 }
 

The checks currently implemented are:

• Require.toHold - requires the given assertion to be true otherwise throws a RequirementFailure
• Require.trueFor - if the given assertion is valid for the given object returns the checked object otherwise throws a RequirementFailure
• Require.nonNull - requires the given object to be not null otherwise throws a RequirementFailure
• Require.nonNull
• Require.nonEmpty - requires the given object to be not empty otherwise throws a RequirementFailure
• Require.nonBlank - requires the given String to be not blank otherwise throws a RequirementFailure

Since:

2.0.0

Author:

Massimo Coluzzi

Method Summary

Modifier and Type	Method and Description
static String	nonBlank(String value) Checks that the specified String satisfies IsNot.blank(String).
static String	nonBlank(String value, String message) Checks that the specified String satisfies IsNot.blank(String) and throws a customized RequirementFailure if not.
static String	nonBlank(String value, Supplier<String> messageSupplier) Checks that the specified String satisfies IsNot.blank(String) and throws a customized RequirementFailure if not.
static boolean[]	nonEmpty(boolean[] value) Checks that the specified array reference is not null nor empty.
static boolean[]	nonEmpty(boolean[] value, String message) Checks that the specified array reference is not null nor empty and throws a customized RequirementFailure if it is.
static boolean[]	nonEmpty(boolean[] value, Supplier<String> messageSupplier) Checks that the specified array reference is not null nor empty and throws a customized RequirementFailure if it is.
static byte[]	nonEmpty(byte[] value) Checks that the specified array reference is not null nor empty.
static byte[]	nonEmpty(byte[] value, String message) Checks that the specified array reference is not null nor empty and throws a customized RequirementFailure if it is.
static byte[]	nonEmpty(byte[] value, Supplier<String> messageSupplier) Checks that the specified array reference is not null nor empty and throws a customized RequirementFailure if it is.
static <V,C extends Collection<V>> C	nonEmpty(C value) Checks that the specified Collection reference is not null nor empty.
static char[]	nonEmpty(char[] value) Checks that the specified array reference is not null nor empty.
static char[]	nonEmpty(char[] value, String message) Checks that the specified array reference is not null nor empty and throws a customized RequirementFailure if it is.
static char[]	nonEmpty(char[] value, Supplier<String> messageSupplier) Checks that the specified array reference is not null nor empty and throws a customized RequirementFailure if it is.
static <V,C extends Collection<V>> C	nonEmpty(C value, String message) Checks that the specified Collection reference is not null nor empty and throws a customized RequirementFailure if it is.
static <V,C extends Collection<V>> C	nonEmpty(C value, Supplier<String> messageSupplier) Checks that the specified Collection reference is not null nor empty and throws a customized RequirementFailure if it is.
static double[]	nonEmpty(double[] value) Checks that the specified array reference is not null nor empty.
static double[]	nonEmpty(double[] value, String message) Checks that the specified array reference is not null nor empty and throws a customized RequirementFailure if it is.
static double[]	nonEmpty(double[] value, Supplier<String> messageSupplier) Checks that the specified array reference is not null nor empty and throws a customized RequirementFailure if it is.
static Emptily	nonEmpty(Emptily value) Checks that the specified Emptily reference is not null nor empty.
static Emptily	nonEmpty(Emptily value, String message) Checks that the specified Emptily reference is not null nor empty and throws a customized RequirementFailure if it is.
static Emptily	nonEmpty(Emptily value, Supplier<String> messageSupplier) Checks that the specified Emptily reference is not null nor empty and throws a customized RequirementFailure if it is.
static float[]	nonEmpty(float[] value) Checks that the specified array reference is not null nor empty.
static float[]	nonEmpty(float[] value, String message) Checks that the specified array reference is not null nor empty and throws a customized RequirementFailure if it is.
static float[]	nonEmpty(float[] value, Supplier<String> messageSupplier) Checks that the specified array reference is not null nor empty and throws a customized RequirementFailure if it is.
static int[]	nonEmpty(int[] value) Checks that the specified array reference is not null nor empty.
static int[]	nonEmpty(int[] value, String message) Checks that the specified array reference is not null nor empty and throws a customized RequirementFailure if it is.
static int[]	nonEmpty(int[] value, Supplier<String> messageSupplier) Checks that the specified array reference is not null nor empty and throws a customized RequirementFailure if it is.
static long[]	nonEmpty(long[] value) Checks that the specified array reference is not null nor empty.
static long[]	nonEmpty(long[] value, String message) Checks that the specified array reference is not null nor empty and throws a customized RequirementFailure if it is.
static long[]	nonEmpty(long[] value, Supplier<String> messageSupplier) Checks that the specified array reference is not null nor empty and throws a customized RequirementFailure if it is.
static <K,V,M extends Map<K,V>> M	nonEmpty(M value) Checks that the specified Map reference is not null nor empty.
static <K,V,M extends Map<K,V>> M	nonEmpty(M value, String message) Checks that the specified Map reference is not null nor empty and throws a customized RequirementFailure if it is.
static <K,V,M extends Map<K,V>> M	nonEmpty(M value, Supplier<String> messageSupplier) Checks that the specified Map reference is not null nor empty and throws a customized RequirementFailure if it is.
static short[]	nonEmpty(short[] value) Checks that the specified array reference is not null nor empty.
static short[]	nonEmpty(short[] value, String message) Checks that the specified array reference is not null nor empty and throws a customized RequirementFailure if it is.
static short[]	nonEmpty(short[] value, Supplier<String> messageSupplier) Checks that the specified array reference is not null nor empty and throws a customized RequirementFailure if it is.
static String	nonEmpty(String value) Checks that the specified String reference is not null nor empty.
static String	nonEmpty(String value, String message) Checks that the specified String reference is not null nor empty and throws a customized RequirementFailure if it is.
static String	nonEmpty(String value, Supplier<String> messageSupplier) Checks that the specified String reference is not null nor empty and throws a customized RequirementFailure if it is.
static <V> V[]	nonEmpty(V[] value) Checks that the specified array reference is not null nor empty.
static <V> V[]	nonEmpty(V[] value, String message) Checks that the specified array reference is not null nor empty and throws a customized RequirementFailure if it is.
static <V> V[]	nonEmpty(V[] value, Supplier<String> messageSupplier) Checks that the specified array reference is not null nor empty and throws a customized RequirementFailure if it is.
static <V> V	nonNull(V value) Checks that the specified object reference is not null.
static <V> V	nonNull(V value, String message) Checks that the specified object reference is not null and throws a customized RequirementFailure if it is.
static <V> V	nonNull(V value, Supplier<String> messageSupplier) Checks that the specified object reference is not null and throws a customized RequirementFailure if it is.
static void	toHold(boolean assertion) Checks the given assertion to be true.
static void	toHold(boolean assertion, String message) Checks the given assertion to be true and throws a customized RequirementFailure if not.
static void	toHold(boolean assertion, Supplier<String> messageSupplier) Checks the given assertion to be true and throws a customized RequirementFailure if not.
static <V> V	trueFor(V value, boolean assertion) Checks the given assertion to hold for the specified value.
static <V> V	trueFor(V value, boolean assertion, String message) Checks the given assertion to hold for the specified value and throws a customized RequirementFailure if not.
static <V> V	trueFor(V value, boolean assertion, Supplier<String> messageSupplier) Checks the given assertion to hold for the specified value.

Methods inherited from class java.lang.Object

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

Method Detail

toHold

public static void toHold(boolean assertion)

Checks the given assertion to be true.

Parameters:

assertion - the assertion that has to be true

Throws:

RequirementFailure - if the assertion is false

toHold

public static void toHold(boolean assertion,
                          String message)

Checks the given assertion to be true and throws a customized RequirementFailure if not.

Parameters:

assertion - the assertion that has to be true

message - detail message to be used in the event that a RequirementFailure is thrown

Throws:

RequirementFailure - if the assertion is false

toHold

public static void toHold(boolean assertion,
                          Supplier<String> messageSupplier)

Checks the given assertion to be true and throws a customized RequirementFailure if not.

Unlike the method toHold(boolean, String), this method allows creation of the message to be deferred until after the null check is made. While this may confer a performance advantage in the non-null case, when deciding to call this method care should be taken that the costs of creating the message supplier are less than the cost of just creating the string message directly.

Parameters:

assertion - the assertion that has to be true

messageSupplier - supplier of the detail message to be used in the event that a RequirementFailure is thrown

Throws:

RequirementFailure - if the assertion is false

trueFor

public static <V> V trueFor(V value,
                            boolean assertion)

Checks the given assertion to hold for the specified value.

The assertion passed to this method should check some property of the given value. If the assertion holds the related value will be returned.

Type Parameters:

V - the type of the value.

Parameters:

value - the value to be checked.

assertion - the assertion relating to the given value that has to be true

Returns:

value if the related assertion holds.

Throws:

RequirementFailure - if the assertion is false, the given value otherwise.

trueFor

public static <V> V trueFor(V value,
                            boolean assertion,
                            String message)

Checks the given assertion to hold for the specified value and throws a customized RequirementFailure if not.

The assertion passed to this method should check some property of the given value. If the assertion holds the related value will be returned

Type Parameters:

V - the type of the value.

Parameters:

value - the value to be checked.

assertion - the assertion that has to be true

message - detail message to be used in the event that a RequirementFailure is thrown

Returns:

value if the related assertion holds.

Throws:

RequirementFailure - if the assertion is false, the given value otherwise.

trueFor

public static <V> V trueFor(V value,
                            boolean assertion,
                            Supplier<String> messageSupplier)

Checks the given assertion to hold for the specified value. and throws a customized RequirementFailure if not.

The assertion passed to this method should check some property of the given value. If the assertion holds the related value will be returned.

Unlike the method trueFor(Object,boolean,String), this method allows creation of the message to be deferred until after the assertion check is made. While this may confer a performance advantage in the good case, when deciding to call this method care should be taken that the costs of creating the message supplier are less than the cost of just creating the string message directly.

Type Parameters:

V - the type of the value.

Parameters:

value - the value to be checked.

assertion - the assertion that has to be true

messageSupplier - supplier of the detail message to be used in the event that a RequirementFailure is thrown

Returns:

value if the related assertion holds.

Throws:

RequirementFailure - if the assertion is false, the given value otherwise.

nonNull

public static <V> V nonNull(V value)

Checks that the specified object reference is not null.

Type Parameters:

V - the type of the reference

Parameters:

value - the object reference to check for nullity

Returns:

value if not null

Throws:

RequirementFailure - if value is null

nonNull

public static <V> V nonNull(V value,
                            String message)

Checks that the specified object reference is not null and throws a customized RequirementFailure if it is.

Type Parameters:

V - the type of the reference

Parameters:

value - the object reference to check for nullity

message - detail message to be used in the event that a RequirementFailure is thrown

Returns:

value if not null

Throws:

RequirementFailure - if value is null

nonNull

public static <V> V nonNull(V value,
                            Supplier<String> messageSupplier)

Checks that the specified object reference is not null and throws a customized RequirementFailure if it is.

Unlike the method nonNull(Object, String), this method allows creation of the message to be deferred until after the null check is made. While this may confer a performance advantage in the non-null case, when deciding to call this method care should be taken that the costs of creating the message supplier are less than the cost of just creating the string message directly.

Type Parameters:

V - the type of the reference

Parameters:

value - the object reference to check for nullity

messageSupplier - supplier of the detail message to be used in the event that a RequirementFailure is thrown

Returns:

value if not null

Throws:

RequirementFailure - if value is null

nonEmpty

public static Emptily nonEmpty(Emptily value)

Checks that the specified Emptily reference is not null nor empty.

Parameters:

value - the Emptily reference to check for emptiness

Returns:

value if not null nor empty

Throws:

RequirementFailure - if value is null

nonEmpty

public static Emptily nonEmpty(Emptily value,
                               String message)

Checks that the specified Emptily reference is not null nor empty and throws a customized RequirementFailure if it is.

Parameters:

value - the Emptily reference to check for emptiness

message - detail message to be used in the event that a RequirementFailure is thrown

Returns:

value if not null nor empty

Throws:

RequirementFailure - if value is null nor empty

nonEmpty

public static Emptily nonEmpty(Emptily value,
                               Supplier<String> messageSupplier)

Checks that the specified Emptily reference is not null nor empty and throws a customized RequirementFailure if it is.

Unlike the method nonEmpty(Emptily, String), this method allows creation of the message to be deferred until after the null check is made. While this may confer a performance advantage in the non-null case, when deciding to call this method care should be taken that the costs of creating the message supplier are less than the cost of just creating the string message directly.

Parameters:

value - the Emptily reference to check for emptiness

messageSupplier - supplier of the detail message to be used in the event that a RequirementFailure is thrown

Returns:

value if not null nor empty

Throws:

RequirementFailure - if value is null nor empty

nonEmpty

public static String nonEmpty(String value)

Checks that the specified String reference is not null nor empty.

Parameters:

value - the String reference to check for emptiness

Returns:

value if not null nor empty

Throws:

RequirementFailure - if value is null

nonEmpty

public static String nonEmpty(String value,
                              String message)

Checks that the specified String reference is not null nor empty and throws a customized RequirementFailure if it is.

Parameters:

value - the String reference to check for emptiness

message - detail message to be used in the event that a RequirementFailure is thrown

Returns:

value if not null nor empty

Throws:

RequirementFailure - if value is null nor empty

nonEmpty

public static String nonEmpty(String value,
                              Supplier<String> messageSupplier)

Checks that the specified String reference is not null nor empty and throws a customized RequirementFailure if it is.

Unlike the method nonEmpty(String, String), this method allows creation of the message to be deferred until after the null check is made. While this may confer a performance advantage in the non-null case, when deciding to call this method care should be taken that the costs of creating the message supplier are less than the cost of just creating the string message directly.

Parameters:

value - the String reference to check for emptiness

messageSupplier - supplier of the detail message to be used in the event that a RequirementFailure is thrown

Returns:

value if not null nor empty

Throws:

RequirementFailure - if value is null nor empty

nonBlank

public static String nonBlank(String value)

Checks that the specified String satisfies IsNot.blank(String).

Parameters:

value - the String reference to check

Returns:

value if satisfies IsNot.blank(String)

Throws:

RequirementFailure - if the check fails

nonBlank

public static String nonBlank(String value,
                              String message)

Checks that the specified String satisfies IsNot.blank(String) and throws a customized RequirementFailure if not.

Parameters:

value - the String reference to check

message - detail message to be used in the event that a RequirementFailure is thrown

Returns:

value if satisfies IsNot.blank(String)

Throws:

RequirementFailure - if the check fails

nonBlank

public static String nonBlank(String value,
                              Supplier<String> messageSupplier)

Checks that the specified String satisfies IsNot.blank(String) and throws a customized RequirementFailure if not.

Unlike the method nonEmpty(String, String), this method allows creation of the message to be deferred until after the null check is made. While this may confer a performance advantage in the non-null case, when deciding to call this method care should be taken that the costs of creating the message supplier are less than the cost of just creating the string message directly.

Parameters:

value - the String reference to check

messageSupplier - supplier of the detail message to be used in the event that a RequirementFailure is thrown

Returns:

value if satisfies IsNot.blank(String)

Throws:

RequirementFailure - if the check fails

nonEmpty

public static <V,C extends Collection<V>> C nonEmpty(C value)

Checks that the specified Collection reference is not null nor empty.

Type Parameters:

V - the type of the elements in the Collection

C - the actual implementation of the Collection

Parameters:

value - the Collection reference to check for emptiness

Returns:

value if not null nor empty

Throws:

RequirementFailure - if value is null

nonEmpty

public static <V,C extends Collection<V>> C nonEmpty(C value,
                                                     String message)

Checks that the specified Collection reference is not null nor empty and throws a customized RequirementFailure if it is.

Type Parameters:

V - the type of the elements in the Collection

C - the actual implementation of the Collection

Parameters:

value - the Collection reference to check for emptiness

message - detail message to be used in the event that a RequirementFailure is thrown

Returns:

value if not null nor empty

Throws:

RequirementFailure - if value is null nor empty

nonEmpty

public static <V,C extends Collection<V>> C nonEmpty(C value,
                                                     Supplier<String> messageSupplier)

Checks that the specified Collection reference is not null nor empty and throws a customized RequirementFailure if it is.

Unlike the method nonEmpty(Collection, String), this method allows creation of the message to be deferred until after the null check is made. While this may confer a performance advantage in the non-null case, when deciding to call this method care should be taken that the costs of creating the message supplier are less than the cost of just creating the string message directly.

Type Parameters:

V - the type of the elements in the Collection

C - the actual implementation of the Collection

Parameters:

value - the Collection reference to check for emptiness

messageSupplier - supplier of the detail message to be used in the event that a RequirementFailure is thrown

Returns:

value if not null nor empty

Throws:

RequirementFailure - if value is null nor empty

nonEmpty

public static <K,V,M extends Map<K,V>> M nonEmpty(M value)

Checks that the specified Map reference is not null nor empty.

Type Parameters:

K - the type of the key elements in the Map

V - the type of the value elements in the Map

M - the actual implementation of the Map

Parameters:

value - the Map reference to check for emptiness

Returns:

value if not null nor empty

Throws:

RequirementFailure - if value is null

nonEmpty

public static <K,V,M extends Map<K,V>> M nonEmpty(M value,
                                                  String message)

Checks that the specified Map reference is not null nor empty and throws a customized RequirementFailure if it is.

Type Parameters:

K - the type of the key elements in the Map

V - the type of the value elements in the Map

M - the actual implementation of the Map

Parameters:

value - the Map reference to check for emptiness

message - detail message to be used in the event that a RequirementFailure is thrown

Returns:

value if not null nor empty

Throws:

RequirementFailure - if value is null nor empty

nonEmpty

public static <K,V,M extends Map<K,V>> M nonEmpty(M value,
                                                  Supplier<String> messageSupplier)

Checks that the specified Map reference is not null nor empty and throws a customized RequirementFailure if it is.

Unlike the method nonEmpty(Map, String), this method allows creation of the message to be deferred until after the null check is made. While this may confer a performance advantage in the non-null case, when deciding to call this method care should be taken that the costs of creating the message supplier are less than the cost of just creating the string message directly.

Type Parameters:

K - the type of the key elements in the Map

V - the type of the value elements in the Map

M - the actual implementation of the Map

Parameters:

value - the Map reference to check for emptiness

messageSupplier - supplier of the detail message to be used in the event that a RequirementFailure is thrown

Returns:

value if not null nor empty

Throws:

RequirementFailure - if value is null nor empty

nonEmpty

public static <V> V[] nonEmpty(V[] value)

Checks that the specified array reference is not null nor empty.

Type Parameters:

V - the type of the elements in the array

Parameters:

value - the array reference to check for emptiness

Returns:

value if not null nor empty

Throws:

RequirementFailure - if the check fails

nonEmpty

public static <V> V[] nonEmpty(V[] value,
                               String message)

Checks that the specified array reference is not null nor empty and throws a customized RequirementFailure if it is.

Type Parameters:

V - the type of the elements in the array

Parameters:

value - the array reference to check for emptiness

message - detail message to be used in the event that a RequirementFailure is thrown

Returns:

value if not null nor empty

Throws:

RequirementFailure - if the check fails

nonEmpty

public static <V> V[] nonEmpty(V[] value,
                               Supplier<String> messageSupplier)

Checks that the specified array reference is not null nor empty and throws a customized RequirementFailure if it is.

Unlike the method nonEmpty(Map, String), this method allows creation of the message to be deferred until after the null check is made. While this may confer a performance advantage in the non-null case, when deciding to call this method care should be taken that the costs of creating the message supplier are less than the cost of just creating the string message directly.

Type Parameters:

V - the type of the elements in the array

Parameters:

value - the array reference to check for emptiness

messageSupplier - supplier of the detail message to be used in the event that a RequirementFailure is thrown

Returns:

value if not null nor empty

Throws:

RequirementFailure - if the check fails

nonEmpty

public static boolean[] nonEmpty(boolean[] value)

Checks that the specified array reference is not null nor empty.

Parameters:

value - the array reference to check for emptiness

Returns:

value if not null nor empty

Throws:

RequirementFailure - if the check fails

nonEmpty

public static boolean[] nonEmpty(boolean[] value,
                                 String message)

Checks that the specified array reference is not null nor empty and throws a customized RequirementFailure if it is.

Parameters:

value - the array reference to check for emptiness

message - detail message to be used in the event that a RequirementFailure is thrown

Returns:

value if not null nor empty

Throws:

RequirementFailure - if the check fails

nonEmpty

public static boolean[] nonEmpty(boolean[] value,
                                 Supplier<String> messageSupplier)

Checks that the specified array reference is not null nor empty and throws a customized RequirementFailure if it is.

Unlike the method nonEmpty(Map, String), this method allows creation of the message to be deferred until after the null check is made. While this may confer a performance advantage in the non-null case, when deciding to call this method care should be taken that the costs of creating the message supplier are less than the cost of just creating the string message directly.

Parameters:

value - the array reference to check for emptiness

messageSupplier - supplier of the detail message to be used in the event that a RequirementFailure is thrown

Returns:

value if not null nor empty

Throws:

RequirementFailure - if the check fails

nonEmpty

public static char[] nonEmpty(char[] value)

Checks that the specified array reference is not null nor empty.

Parameters:

value - the array reference to check for emptiness

Returns:

value if not null nor empty

Throws:

RequirementFailure - if the check fails

nonEmpty

public static char[] nonEmpty(char[] value,
                              String message)

Checks that the specified array reference is not null nor empty and throws a customized RequirementFailure if it is.

Parameters:

value - the array reference to check for emptiness

message - detail message to be used in the event that a RequirementFailure is thrown

Returns:

value if not null nor empty

Throws:

RequirementFailure - if the check fails

nonEmpty

public static char[] nonEmpty(char[] value,
                              Supplier<String> messageSupplier)

Checks that the specified array reference is not null nor empty and throws a customized RequirementFailure if it is.

Unlike the method nonEmpty(Map, String), this method allows creation of the message to be deferred until after the null check is made. While this may confer a performance advantage in the non-null case, when deciding to call this method care should be taken that the costs of creating the message supplier are less than the cost of just creating the string message directly.

Parameters:

value - the array reference to check for emptiness

messageSupplier - supplier of the detail message to be used in the event that a RequirementFailure is thrown

Returns:

value if not null nor empty

Throws:

RequirementFailure - if the check fails

nonEmpty

public static byte[] nonEmpty(byte[] value)

Checks that the specified array reference is not null nor empty.

Parameters:

value - the array reference to check for emptiness

Returns:

value if not null nor empty

Throws:

RequirementFailure - if the check fails

nonEmpty

public static byte[] nonEmpty(byte[] value,
                              String message)

Checks that the specified array reference is not null nor empty and throws a customized RequirementFailure if it is.

Parameters:

value - the array reference to check for emptiness

message - detail message to be used in the event that a RequirementFailure is thrown

Returns:

value if not null nor empty

Throws:

RequirementFailure - if the check fails

nonEmpty

public static byte[] nonEmpty(byte[] value,
                              Supplier<String> messageSupplier)

Checks that the specified array reference is not null nor empty and throws a customized RequirementFailure if it is.

Unlike the method nonEmpty(Map, String), this method allows creation of the message to be deferred until after the null check is made. While this may confer a performance advantage in the non-null case, when deciding to call this method care should be taken that the costs of creating the message supplier are less than the cost of just creating the string message directly.

Parameters:

value - the array reference to check for emptiness

messageSupplier - supplier of the detail message to be used in the event that a RequirementFailure is thrown

Returns:

value if not null nor empty

Throws:

RequirementFailure - if the check fails

nonEmpty

public static short[] nonEmpty(short[] value)

Checks that the specified array reference is not null nor empty.

Parameters:

value - the array reference to check for emptiness

Returns:

value if not null nor empty

Throws:

RequirementFailure - if the check fails

nonEmpty

public static short[] nonEmpty(short[] value,
                               String message)

Checks that the specified array reference is not null nor empty and throws a customized RequirementFailure if it is.

Parameters:

value - the array reference to check for emptiness

message - detail message to be used in the event that a RequirementFailure is thrown

Returns:

value if not null nor empty

Throws:

RequirementFailure - if the check fails

nonEmpty

public static short[] nonEmpty(short[] value,
                               Supplier<String> messageSupplier)

Checks that the specified array reference is not null nor empty and throws a customized RequirementFailure if it is.

Unlike the method nonEmpty(Map, String), this method allows creation of the message to be deferred until after the null check is made. While this may confer a performance advantage in the non-null case, when deciding to call this method care should be taken that the costs of creating the message supplier are less than the cost of just creating the string message directly.

Parameters:

value - the array reference to check for emptiness

messageSupplier - supplier of the detail message to be used in the event that a RequirementFailure is thrown

Returns:

value if not null nor empty

Throws:

RequirementFailure - if the check fails

nonEmpty

public static int[] nonEmpty(int[] value)

Checks that the specified array reference is not null nor empty.

Parameters:

value - the array reference to check for emptiness

Returns:

value if not null nor empty

Throws:

RequirementFailure - if the check fails

nonEmpty

public static int[] nonEmpty(int[] value,
                             String message)

Checks that the specified array reference is not null nor empty and throws a customized RequirementFailure if it is.

Parameters:

value - the array reference to check for emptiness

message - detail message to be used in the event that a RequirementFailure is thrown

Returns:

value if not null nor empty

Throws:

RequirementFailure - if the check fails

nonEmpty

public static int[] nonEmpty(int[] value,
                             Supplier<String> messageSupplier)

Checks that the specified array reference is not null nor empty and throws a customized RequirementFailure if it is.

Unlike the method nonEmpty(Map, String), this method allows creation of the message to be deferred until after the null check is made. While this may confer a performance advantage in the non-null case, when deciding to call this method care should be taken that the costs of creating the message supplier are less than the cost of just creating the string message directly.

Parameters:

value - the array reference to check for emptiness

messageSupplier - supplier of the detail message to be used in the event that a RequirementFailure is thrown

Returns:

value if not null nor empty

Throws:

RequirementFailure - if the check fails

nonEmpty

public static float[] nonEmpty(float[] value)

Checks that the specified array reference is not null nor empty.

Parameters:

value - the array reference to check for emptiness

Returns:

value if not null nor empty

Throws:

RequirementFailure - if the check fails

nonEmpty

public static float[] nonEmpty(float[] value,
                               String message)

Checks that the specified array reference is not null nor empty and throws a customized RequirementFailure if it is.

Parameters:

value - the array reference to check for emptiness

message - detail message to be used in the event that a RequirementFailure is thrown

Returns:

value if not null nor empty

Throws:

RequirementFailure - if the check fails

nonEmpty

public static float[] nonEmpty(float[] value,
                               Supplier<String> messageSupplier)

Checks that the specified array reference is not null nor empty and throws a customized RequirementFailure if it is.

Unlike the method nonEmpty(Map, String), this method allows creation of the message to be deferred until after the null check is made. While this may confer a performance advantage in the non-null case, when deciding to call this method care should be taken that the costs of creating the message supplier are less than the cost of just creating the string message directly.

Parameters:

value - the array reference to check for emptiness

messageSupplier - supplier of the detail message to be used in the event that a RequirementFailure is thrown

Returns:

value if not null nor empty

Throws:

RequirementFailure - if the check fails

nonEmpty

public static long[] nonEmpty(long[] value)

Checks that the specified array reference is not null nor empty.

Parameters:

value - the array reference to check for emptiness

Returns:

value if not null nor empty

Throws:

RequirementFailure - if the check fails

nonEmpty

public static long[] nonEmpty(long[] value,
                              String message)

Checks that the specified array reference is not null nor empty and throws a customized RequirementFailure if it is.

Parameters:

value - the array reference to check for emptiness

message - detail message to be used in the event that a RequirementFailure is thrown

Returns:

value if not null nor empty

Throws:

RequirementFailure - if the check fails

nonEmpty

public static long[] nonEmpty(long[] value,
                              Supplier<String> messageSupplier)

Checks that the specified array reference is not null nor empty and throws a customized RequirementFailure if it is.

Unlike the method nonEmpty(Map, String), this method allows creation of the message to be deferred until after the null check is made. While this may confer a performance advantage in the non-null case, when deciding to call this method care should be taken that the costs of creating the message supplier are less than the cost of just creating the string message directly.

Parameters:

value - the array reference to check for emptiness

messageSupplier - supplier of the detail message to be used in the event that a RequirementFailure is thrown

Returns:

value if not null nor empty

Throws:

RequirementFailure - if the check fails

nonEmpty

public static double[] nonEmpty(double[] value)

Checks that the specified array reference is not null nor empty.

Parameters:

value - the array reference to check for emptiness

Returns:

value if not null nor empty

Throws:

RequirementFailure - if the check fails

nonEmpty

public static double[] nonEmpty(double[] value,
                                String message)

Checks that the specified array reference is not null nor empty and throws a customized RequirementFailure if it is.

Parameters:

value - the array reference to check for emptiness

message - detail message to be used in the event that a RequirementFailure is thrown

Returns:

value if not null nor empty

Throws:

RequirementFailure - if the check fails

nonEmpty

public static double[] nonEmpty(double[] value,
                                Supplier<String> messageSupplier)

Checks that the specified array reference is not null nor empty and throws a customized RequirementFailure if it is.

Unlike the method nonEmpty(Map, String), this method allows creation of the message to be deferred until after the null check is made. While this may confer a performance advantage in the non-null case, when deciding to call this method care should be taken that the costs of creating the message supplier are less than the cost of just creating the string message directly.

Parameters:

value - the array reference to check for emptiness

messageSupplier - supplier of the detail message to be used in the event that a RequirementFailure is thrown

Returns:

value if not null nor empty

Throws:

RequirementFailure - if the check fails