com.prosysopc.ua

Class InternalArguments

java.lang.Object

com.prosysopc.ua.InternalArguments

public abstract class InternalArguments
extends Object

Internal validation util for validating constructor and method parameters. Public as used from multiple packages. Methods in this class can change at will.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InternalArguments.NegativeArgumentException Indicates a parameter was a negative number when 0 or positive was expected.
static class	InternalArguments.NullArgumentException Indicates a parameter was null when no nulls are allowed.

Constructor Summary

Constructors

Constructor and Description
InternalArguments()

Method Summary

Modifier and Type	Method and Description
static int	checkNotNegative(int value) If given value is less than 0, throws InternalArguments.NegativeArgumentException, otherwise returns it.
static int	checkNotNegative(int value, String parameterName) If given value is less than 0, throws InternalArguments.NegativeArgumentException (with the message 'The given " + parameterName + " cannot be negative'), otherwise returns it.
static <T> T	checkNotNull(T obj) If the given object is null, throws InternalArguments.NullArgumentException, otherwise returns it.
static <T> T	checkNotNull(T obj, String parameterName) If the given object is null, throws InternalArguments.NullArgumentException (with the message 'The given " + parameterName + " cannot be null'), otherwise returns it.
static <T> T[]	checkNotNullArrayAndElements(T[] array) Throws InternalArguments.NullArgumentException if the given array is null or contains a null element, otherwise returns it.
static <T> T[]	checkNotNullArrayAndElements(T[] array, String parameterName) Throws InternalArguments.NullArgumentException, if the given array is null or contains a null element, otherwise returns it.
static <T extends Collection<E>,E> T	checkNotNullCollectionAndElements(T collection) Throws InternalArguments.NullArgumentException if the given collection is null or contains a null element, otherwise returns it.
static <T extends Collection<E>,E> T	checkNotNullCollectionAndElements(T collection, String parameterName) Throws InternalArguments.NullArgumentException if the given collection is null or contains a null element, otherwise returns it.

Methods inherited from class java.lang.Object

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

Constructor Detail

InternalArguments

public InternalArguments()

Method Detail

checkNotNegative

public static int checkNotNegative(int value)

If given value is less than 0, throws InternalArguments.NegativeArgumentException, otherwise returns it.

checkNotNegative

public static int checkNotNegative(int value,
                                   String parameterName)

If given value is less than 0, throws InternalArguments.NegativeArgumentException (with the message 'The given " + parameterName + " cannot be negative'), otherwise returns it.

checkNotNull

public static <T> T checkNotNull(T obj)

If the given object is null, throws InternalArguments.NullArgumentException, otherwise returns it.

checkNotNull

public static <T> T checkNotNull(T obj,
                                 String parameterName)

If the given object is null, throws InternalArguments.NullArgumentException (with the message 'The given " + parameterName + " cannot be null'), otherwise returns it.

checkNotNullArrayAndElements

public static <T> T[] checkNotNullArrayAndElements(T[] array)

Throws InternalArguments.NullArgumentException if the given array is null or contains a null element, otherwise returns it.

checkNotNullArrayAndElements

public static <T> T[] checkNotNullArrayAndElements(T[] array,
                                                   String parameterName)

Throws InternalArguments.NullArgumentException, if the given array is null or contains a null element, otherwise returns it.

checkNotNullCollectionAndElements

public static <T extends Collection<E>,E> T checkNotNullCollectionAndElements(T collection)

Throws InternalArguments.NullArgumentException if the given collection is null or contains a null element, otherwise returns it.

checkNotNullCollectionAndElements

public static <T extends Collection<E>,E> T checkNotNullCollectionAndElements(T collection,
                                                                              String parameterName)

Throws InternalArguments.NullArgumentException if the given collection is null or contains a null element, otherwise returns it.