Class Validate
Assists in validating arguments.
The class is based along the lines of JUnit. If an argument value is deemed invalid, an IllegalArgumentException is thrown. For example:
Validate.isTrue( i > 0, "The value must be greater than zero: ", i); Validate.notNull( surname, "The surname must not be null");
- Since:
- 2.0
- Version:
- $Id$
- Author:
- Ola Berg, Stephen Colebourne, Gary Gregory, Norm Deane
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic voidallElementsOfType(Collection<?> collection, Class<?> clazz) Validate an argument, throwingIllegalArgumentExceptionif the argument collection isnullor has elements that are not of typeclazzor a subclass.static voidallElementsOfType(Collection<?> collection, Class<?> clazz, String message) Validate an argument, throwingIllegalArgumentExceptionif the argument collection isnullor has elements that are not of typeclazzor a subclass.static voidisTrue(boolean expression) Validate an argument, throwingIllegalArgumentExceptionif the test result isfalse.static voidValidate an argument, throwingIllegalArgumentExceptionif the test result isfalse.static voidValidate an argument, throwingIllegalArgumentExceptionif the test result isfalse.static voidValidate an argument, throwingIllegalArgumentExceptionif the test result isfalse.static voidValidate an argument, throwingIllegalArgumentExceptionif the test result isfalse.static voidnoNullElements(Object[] array) Validate an argument, throwingIllegalArgumentExceptionif the argument array hasnullelements or isnull.static voidnoNullElements(Object[] array, String message) Validate an argument, throwingIllegalArgumentExceptionif the argument array hasnullelements or isnull.static voidnoNullElements(Collection<?> collection) Validate an argument, throwingIllegalArgumentExceptionif the argument Collection hasnullelements or isnull.static voidnoNullElements(Collection<?> collection, String message) Validate an argument, throwingIllegalArgumentExceptionif the argument Collection hasnullelements or isnull.static voidValidate an argument, throwingIllegalArgumentExceptionif the argument array is empty (nullor no elements).static voidValidate an argument, throwingIllegalArgumentExceptionif the argument array is empty (nullor no elements).static voidValidate an argument, throwingIllegalArgumentExceptionif the argument String is empty (nullor zero length).static voidValidate an argument, throwingIllegalArgumentExceptionif the argument String is empty (nullor zero length).static voidnotEmpty(Collection<?> collection) Validate an argument, throwingIllegalArgumentExceptionif the argument Collection is empty (nullor no elements).static voidnotEmpty(Collection<?> collection, String message) Validate an argument, throwingIllegalArgumentExceptionif the argument Collection is empty (nullor no elements).static voidValidate an argument, throwingIllegalArgumentExceptionif the argument Map is empty (nullor no elements).static voidValidate an argument, throwingIllegalArgumentExceptionif the argument Map is empty (nullor no elements).static voidValidate an argument, throwingIllegalArgumentExceptionif the argument isnull.static voidValidate an argument, throwingIllegalArgumentExceptionif the argument isnull.
-
Constructor Details
-
Validate
public Validate()Constructor. This class should not normally be instantiated.
-
-
Method Details
-
isTrue
Validate an argument, throwing
IllegalArgumentExceptionif the test result isfalse.This is used when validating according to an arbitrary boolean expression, such as validating a primitive number or using your own custom validation expression.
Validate.isTrue( myObject.isOk(), "The object is not OK: ", myObject);
For performance reasons, the object is passed as a separate parameter and appended to the message string only in the case of an error.
- Parameters:
expression- a boolean expressionmessage- the exception message you would like to see if the expression isfalsevalue- the value to append to the message in case of error- Throws:
IllegalArgumentException- if expression isfalse
-
isTrue
Validate an argument, throwing
IllegalArgumentExceptionif the test result isfalse.This is used when validating according to an arbitrary boolean expression, such as validating a primitive number or using your own custom validation expression.
Validate.isTrue( i > 0, "The value must be greater than zero: ", i);
For performance reasons, the long value is passed as a separate parameter and appended to the message string only in the case of an error.
- Parameters:
expression- a boolean expressionmessage- the exception message you would like to see if the expression isfalsevalue- the value to append to the message in case of error- Throws:
IllegalArgumentException- if expression isfalse
-
isTrue
Validate an argument, throwing
IllegalArgumentExceptionif the test result isfalse.This is used when validating according to an arbitrary boolean expression, such as validating a primitive number or using your own custom validation expression.
Validate.isTrue( d > 0.0, "The value must be greater than zero: ", d);
For performance reasons, the double value is passed as a separate parameter and appended to the message string only in the case of an error.
- Parameters:
expression- a boolean expressionmessage- the exception message you would like to see if the expression isfalsevalue- the value to append to the message in case of error- Throws:
IllegalArgumentException- if expression isfalse
-
isTrue
Validate an argument, throwing
IllegalArgumentExceptionif the test result isfalse.This is used when validating according to an arbitrary boolean expression, such as validating a primitive number or using your own custom validation expression.
Validate.isTrue( (i > 0), "The value must be greater than zero"); Validate.isTrue( myObject.isOk(), "The object is not OK");
For performance reasons, the message string should not involve a string append, instead use the
isTrue(boolean, String, Object)method.- Parameters:
expression- a boolean expressionmessage- the exception message you would like to see if the expression isfalse- Throws:
IllegalArgumentException- if expression isfalse
-
isTrue
public static void isTrue(boolean expression) Validate an argument, throwing
IllegalArgumentExceptionif the test result isfalse.This is used when validating according to an arbitrary boolean expression, such as validating a primitive number or using your own custom validation expression.
Validate.isTrue( i > 0 ); Validate.isTrue( myObject.isOk() );
The message in the exception is 'The validated expression is false'.
- Parameters:
expression- a boolean expression- Throws:
IllegalArgumentException- if expression isfalse
-
notNull
Validate an argument, throwing
IllegalArgumentExceptionif the argument isnull.Validate.notNull(myObject, "The object must not be null");
- Parameters:
object- the object to check is notnullmessage- the exception message you would like to see if the object isnull- Throws:
IllegalArgumentException- if the object isnull
-
notNull
Validate an argument, throwing
IllegalArgumentExceptionif the argument isnull.Validate.notNull(myObject);
The message in the exception is 'The validated object is null'.
- Parameters:
object- the object to check is notnull- Throws:
IllegalArgumentException- if the object isnull
-
notEmpty
Validate an argument, throwing
IllegalArgumentExceptionif the argument array is empty (nullor no elements).Validate.notEmpty(myArray, "The array must not be empty");
- Parameters:
array- the array to check is not emptymessage- the exception message you would like to see if the array is empty- Throws:
IllegalArgumentException- if the array is empty
-
notEmpty
Validate an argument, throwing
IllegalArgumentExceptionif the argument array is empty (nullor no elements).Validate.notEmpty(myArray);
The message in the exception is 'The validated array is empty'.
- Parameters:
array- the array to check is not empty- Throws:
IllegalArgumentException- if the array is empty
-
notEmpty
Validate an argument, throwing
IllegalArgumentExceptionif the argument Collection is empty (nullor no elements).Validate.notEmpty(myCollection, "The collection must not be empty");
- Parameters:
collection- the collection to check is not emptymessage- the exception message you would like to see if the collection is empty- Throws:
IllegalArgumentException- if the collection is empty
-
notEmpty
Validate an argument, throwing
IllegalArgumentExceptionif the argument Collection is empty (nullor no elements).Validate.notEmpty(myCollection);
The message in the exception is 'The validated collection is empty'.
- Parameters:
collection- the collection to check is not empty- Throws:
IllegalArgumentException- if the collection is empty
-
notEmpty
Validate an argument, throwing
IllegalArgumentExceptionif the argument Map is empty (nullor no elements).Validate.notEmpty(myMap, "The map must not be empty");
- Parameters:
map- the map to check is not emptymessage- the exception message you would like to see if the map is empty- Throws:
IllegalArgumentException- if the map is empty
-
notEmpty
Validate an argument, throwing
IllegalArgumentExceptionif the argument Map is empty (nullor no elements).Validate.notEmpty(myMap);
The message in the exception is 'The validated map is empty'.
- Parameters:
map- the map to check is not empty- Throws:
IllegalArgumentException- if the map is empty
-
notEmpty
Validate an argument, throwing
IllegalArgumentExceptionif the argument String is empty (nullor zero length).Validate.notEmpty(myString, "The string must not be empty");
- Parameters:
string- the string to check is not emptymessage- the exception message you would like to see if the string is empty- Throws:
IllegalArgumentException- if the string is empty
-
notEmpty
Validate an argument, throwing
IllegalArgumentExceptionif the argument String is empty (nullor zero length).Validate.notEmpty(myString);
The message in the exception is 'The validated string is empty'.
- Parameters:
string- the string to check is not empty- Throws:
IllegalArgumentException- if the string is empty
-
noNullElements
Validate an argument, throwing
IllegalArgumentExceptionif the argument array hasnullelements or isnull.Validate.noNullElements(myArray, "The array must not contain null elements");
If the array is null then the message in the exception is 'The validated object is null'.
- Parameters:
array- the array to checkmessage- the exception message if the array hasnullelements- Throws:
IllegalArgumentException- if the array hasnullelements or isnull
-
noNullElements
Validate an argument, throwing
IllegalArgumentExceptionif the argument array hasnullelements or isnull.Validate.noNullElements(myArray);
If the array has a null element the message in the exception is 'The validated array contains null element at index: '.
If the array is null then the message in the exception is 'The validated object is null'.
- Parameters:
array- the array to check- Throws:
IllegalArgumentException- if the array hasnullelements or isnull
-
noNullElements
Validate an argument, throwing
IllegalArgumentExceptionif the argument Collection hasnullelements or isnull.Validate.noNullElements(myCollection, "The collection must not contain null elements");
If the collection is null then the message in the exception is 'The validated object is null'.
- Parameters:
collection- the collection to checkmessage- the exception message if the collection hasnullelements- Throws:
IllegalArgumentException- if the collection hasnullelements or isnull
-
noNullElements
Validate an argument, throwing
IllegalArgumentExceptionif the argument Collection hasnullelements or isnull.Validate.noNullElements(myCollection);
The message in the exception is 'The validated collection contains null element at index: '.
If the collection is null then the message in the exception is 'The validated object is null'.
- Parameters:
collection- the collection to check- Throws:
IllegalArgumentException- if the collection hasnullelements or isnull
-
allElementsOfType
Validate an argument, throwing
IllegalArgumentExceptionif the argument collection isnullor has elements that are not of typeclazzor a subclass.Validate.allElementsOfType(collection, String.class, "Collection has invalid elements");
- Parameters:
collection- the collection to check, not nullclazz- theClasswhich the collection's elements are expected to be, not nullmessage- the exception message if theCollectionhas elements not of typeclazz- Since:
- 2.1
-
allElementsOfType
Validate an argument, throwing
IllegalArgumentExceptionif the argument collection isnullor has elements that are not of typeclazzor a subclass.Validate.allElementsOfType(collection, String.class);
The message in the exception is 'The validated collection contains an element not of type clazz at index: '.
- Parameters:
collection- the collection to check, not nullclazz- theClasswhich the collection's elements are expected to be, not null- Since:
- 2.1
-