Org apache commons lang validate java
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: Validate.java,v 1.6 2003/08/23 10:39:20 scolebourne Exp $ Author: Ola Berg, Stephen Colebourne, Gary Gregory
Constructor Summary | |
Validate () Constructor. |
Method Summary | |
static void | isTrue (boolean expression) Validate an argument, throwing IllegalArgumentException if the test result is false . |
static void | isTrue (boolean expression, String message) Validate an argument, throwing IllegalArgumentException if the test result is false . |
static void | isTrue (boolean expression, String message, double value) Validate an argument, throwing IllegalArgumentException if the test result is false . |
static void | isTrue (boolean expression, String message, long value) Validate an argument, throwing IllegalArgumentException if the test result is false . |
static void | isTrue (boolean expression, String message, Object value) Validate an argument, throwing IllegalArgumentException if the test result is false . |
static void | noNullElements (Collection collection) Validate an argument, throwing IllegalArgumentException if the argument collection has null elements or is null . |
static void | noNullElements (Collection collection, String message) Validate an argument, throwing IllegalArgumentException if the argument collection has null elements or is null . |
static void | noNullElements (Object[] array) Validate an argument, throwing IllegalArgumentException if the argument array has null elements or is null . |
static void | noNullElements (Object[] array, String message) Validate an argument, throwing IllegalArgumentException if the argument array has null elements or is null . |
static void | notEmpty (Collection collection) Validate an argument, throwing IllegalArgumentException if the argument Collection is empty ( null or no elements). |
static void | notEmpty (Collection collection, String message) Validate an argument, throwing IllegalArgumentException if the argument Collection is empty ( null or no elements). |
static void | notEmpty (Map map) Validate an argument, throwing IllegalArgumentException if the argument Map is empty ( null or no elements). |
static void | notEmpty (Map map, String message) Validate an argument, throwing IllegalArgumentException if the argument Map is empty ( null or no elements). |
static void | notEmpty (Object[] array) Validate an argument, throwing IllegalArgumentException if the argument array is empty ( null or no elements). |
static void | notEmpty (Object[] array, String message) Validate an argument, throwing IllegalArgumentException if the argument array is empty ( null or no elements). |
static void | notEmpty (String string) Validate an argument, throwing IllegalArgumentException if the argument String is empty ( null or zero length). |
static void | notEmpty (String string, String message) Validate an argument, throwing IllegalArgumentException if the argument String is empty ( null or zero length). |
static void | notNull (Object object) Validate an argument, throwing IllegalArgumentException if the argument is null . |
static void | notNull (Object object, String message) Validate an argument, throwing IllegalArgumentException if the argument is null . |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Validate
isTrue
Validate an argument, throwing IllegalArgumentException if the test result is false .
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 expression message — the exception message you would like to see if the expression is false value — the value to append to the message in case of error Throws: IllegalArgumentException — if expression is false
isTrue
Validate an argument, throwing IllegalArgumentException if the test result is false .
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 object is passed as a separate parameter and appended to the message string only in the case of an error.
Parameters: expression — a boolean expression message — the exception message you would like to see if the expression is false value — the value to append to the message in case of error Throws: IllegalArgumentException — if expression is false
isTrue
Validate an argument, throwing IllegalArgumentException if the test result is false .
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 object is passed as a separate parameter and appended to the message string only in the case of an error.
Parameters: expression — a boolean expression message — the exception message you would like to see if the expression is false value — the value to append to the message in case of error Throws: IllegalArgumentException — if expression is false
isTrue
Validate an argument, throwing IllegalArgumentException if the test result is false .
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 expression message — the exception message you would like to see if the expression is false Throws: IllegalArgumentException — if expression is false
isTrue
public static void isTrue(boolean expression)
Validate an argument, throwing IllegalArgumentException if the test result is false .
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 is false
notNull
Validate an argument, throwing IllegalArgumentException if the argument is null .
Validate.notNull(myObject, "The object must not be null");
Parameters: object — the object to check is not null message — the exception message you would like to see if the object is null Throws: IllegalArgumentException — if the object is null
notNull
Validate an argument, throwing IllegalArgumentException if the argument is null .
The message in the exception is ‘The validated object is null’.
Parameters: object — the object to check is not null Throws: IllegalArgumentException — if the object is null
notEmpty
Validate an argument, throwing IllegalArgumentException 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 empty message — 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 IllegalArgumentException if the argument array is empty ( null or no elements).
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
public static void notEmpty(Collection collection, String message)
Validate an argument, throwing IllegalArgumentException 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 empty message — 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 IllegalArgumentException 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 Throws: IllegalArgumentException — if the collection is empty
notEmpty
Validate an argument, throwing IllegalArgumentException if the argument Map is empty ( null or no elements).
Validate.notEmpty(myMap, "The collection must not be empty");
Parameters: map — the map to check is not empty message — 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 IllegalArgumentException if the argument Map is empty ( null or no elements).
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 IllegalArgumentException 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 empty message — 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 IllegalArgumentException if the argument String is empty ( null or zero length).
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 IllegalArgumentException if the argument array has null elements or is null .
Validate.notEmpty(myArray, "The array must not contain null elements");
Parameters: array — the array to check message — the exception message if the array has null elements Throws: IllegalArgumentException — if the array has null elements or is null
noNullElements
Validate an argument, throwing IllegalArgumentException if the argument array has null elements or is null .
The message in the exception is ‘The validated array contains null element at index: ‘.
Parameters: array — the array to check Throws: IllegalArgumentException — if the array has null elements or is null
noNullElements
public static void noNullElements(Collection collection, String message)
Validate an argument, throwing IllegalArgumentException if the argument collection has null elements or is null .
Validate.notEmpty(myCollection, "The collection must not contain null elements");
Parameters: collection — the collection to check message — the exception message if the array has null elements Throws: IllegalArgumentException — if the collection has null elements or is null
noNullElements
Validate an argument, throwing IllegalArgumentException if the argument collection has null elements or is null .
Validate.notEmpty(myCollection);
The message in the exception is ‘The validated collection contains null element at index: ‘.
Parameters: collection — the collection to check Throws: IllegalArgumentException — if the collection has null elements or is null
| ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |