Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
org.apache.commons.lang.Validate
public class Validate
extends Object
Validate.isTrue( i > 0, "The value must be greater than zero: ", i); Validate.notNull( surname, "The surname must not be null");
Constructor Summary | |
|
Method Summary | |
static void |
|
static void |
|
static void |
|
static void |
|
static void |
|
static void |
|
static void |
|
static void |
|
static void |
|
static void |
|
static void |
|
static void |
|
static void |
|
static void |
|
static void |
|
static void |
|
static void |
|
static void |
|
static void |
|
static void |
|
static void |
|
public static void allElementsOfType(Collection collection, Class clazz)
Validate an argument, throwingIllegalArgumentException
if the argument collection isnull
or has elements that are not of typeclazz
or 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
- theClass
which the collection's elements are expected to be, not null
- Since:
- 2.1
public static void allElementsOfType(Collection collection, Class clazz, String message)
Validate an argument, throwingIllegalArgumentException
if the argument collection isnull
or has elements that are not of typeclazz
or a subclass.Validate.allElementsOfType(collection, String.class, "Collection has invalid elements");
- Parameters:
collection
- the collection to check, not nullclazz
- theClass
which the collection's elements are expected to be, not nullmessage
- the exception message if theCollection
has elements not of typeclazz
- Since:
- 2.1
public static void isTrue(boolean expression)
Validate an argument, throwingIllegalArgumentException
if 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
public static void isTrue(boolean expression, String message)
Validate an argument, throwingIllegalArgumentException
if 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 theisTrue(boolean,String,Object)
method.
- Parameters:
expression
- a boolean expressionmessage
- the exception message you would like to see if the expression isfalse
public static void isTrue(boolean expression, String message, Object value)
Validate an argument, throwingIllegalArgumentException
if 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 isfalse
value
- the value to append to the message in case of error
public static void isTrue(boolean expression, String message, double value)
Validate an argument, throwingIllegalArgumentException
if 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 isfalse
value
- the value to append to the message in case of error
public static void isTrue(boolean expression, String message, long value)
Validate an argument, throwingIllegalArgumentException
if 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 isfalse
value
- the value to append to the message in case of error
public static void noNullElements(Collection collection)
Validate an argument, throwingIllegalArgumentException
if the argument Collection hasnull
elements 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
public static void noNullElements(Collection collection, String message)
Validate an argument, throwingIllegalArgumentException
if the argument Collection hasnull
elements 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 hasnull
elements
public static void noNullElements(Object[] array)
Validate an argument, throwingIllegalArgumentException
if the argument array hasnull
elements 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
public static void noNullElements(Object[] array, String message)
Validate an argument, throwingIllegalArgumentException
if the argument array hasnull
elements 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 hasnull
elements
public static void notEmpty(Collection collection)
Validate an argument, throwingIllegalArgumentException
if the argument Collection is empty (null
or 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
public static void notEmpty(Collection collection, String message)
Validate an argument, throwingIllegalArgumentException
if the argument Collection is empty (null
or 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
public static void notEmpty(Map map)
Validate an argument, throwingIllegalArgumentException
if the argument Map is empty (null
or 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
public static void notEmpty(Map map, String message)
Validate an argument, throwingIllegalArgumentException
if the argument Map is empty (null
or 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
public static void notEmpty(Object[] array)
Validate an argument, throwingIllegalArgumentException
if the argument array is empty (null
or 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
public static void notEmpty(Object[] array, String message)
Validate an argument, throwingIllegalArgumentException
if the argument array is empty (null
or 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
public static void notEmpty(String string)
Validate an argument, throwingIllegalArgumentException
if the argument String is empty (null
or 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
public static void notEmpty(String string, String message)
Validate an argument, throwingIllegalArgumentException
if the argument String is empty (null
or 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
public static void notNull(Object object)
Validate an argument, throwingIllegalArgumentException
if 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
public static void notNull(Object object, String message)
Validate an argument, throwingIllegalArgumentException
if the argument isnull
.Validate.notNull(myObject, "The object must not be null");
- Parameters:
object
- the object to check is notnull
message
- the exception message you would like to see if the object isnull