org.apache.commons.lang.Validate Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.commons.lang;
import java.util.Collection;
import java.util.Iterator;
import java.util.Map;
/**
* This class 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");
*
*
* @author Apache Software Foundation
* @author Ola Berg
* @author Gary Gregory
* @author Norm Deane
* @since 2.0
* @version $Id: Validate.java 1057051 2011-01-09 23:15:51Z sebb $
*/
public class Validate {
// Validate has no dependencies on other classes in Commons Lang at present
/**
* Constructor. This class should not normally be instantiated.
*/
public Validate() {
super();
}
// isTrue
//---------------------------------------------------------------------------------
/**
* Validate that the argument condition is true; otherwise
* throwing an exception with the specified message. This method is useful when
* validating according to an arbitrary boolean expression, such as validating an
* object or using your own custom validation expression.
*
* Validate.isTrue( myObject.isOk(), "The object is not OK: ", myObject);
*
* For performance reasons, the object value is passed as a separate parameter and
* appended to the exception message only in the case of an error.
*
* @param expression the boolean expression to check
* @param message the exception message if invalid
* @param value the value to append to the message when invalid
* @throws IllegalArgumentException if expression is false
*/
public static void isTrue(boolean expression, String message, Object value) {
if (expression == false) {
throw new IllegalArgumentException(message + value);
}
}
/**
* Validate that the argument condition is true; otherwise
* throwing an exception with the specified message. This method is useful 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.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 exception message only in the case of an error.
*
* @param expression the boolean expression to check
* @param message the exception message if invalid
* @param value the value to append to the message when invalid
* @throws IllegalArgumentException if expression is false
*/
public static void isTrue(boolean expression, String message, long value) {
if (expression == false) {
throw new IllegalArgumentException(message + value);
}
}
/**
* Validate that the argument condition is true; otherwise
* throwing an exception with the specified message. This method is useful 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 exception message only in the case of an error.
*
* @param expression the boolean expression to check
* @param message the exception message if invalid
* @param value the value to append to the message when invalid
* @throws IllegalArgumentException if expression is false
*/
public static void isTrue(boolean expression, String message, double value) {
if (expression == false) {
throw new IllegalArgumentException(message + value);
}
}
/**
* Validate that the argument condition is true; otherwise
* throwing an exception with the specified message. This method is useful 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");
*
*
* @param expression the boolean expression to check
* @param message the exception message if invalid
* @throws IllegalArgumentException if expression is false
*/
public static void isTrue(boolean expression, String message) {
if (expression == false) {
throw new IllegalArgumentException(message);
}
}
/**
* Validate that the argument condition is true; otherwise
* throwing an exception. This method is useful 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 of the exception is "The validated expression is
* false".
*
* @param expression the boolean expression to check
* @throws IllegalArgumentException if expression is false
*/
public static void isTrue(boolean expression) {
if (expression == false) {
throw new IllegalArgumentException("The validated expression is false");
}
}
// notNull
//---------------------------------------------------------------------------------
/**
* Validate that the specified argument is not null;
* otherwise throwing an exception.
*
*
Validate.notNull(myObject);
*
* The message of the exception is "The validated object is
* null".
*
* @param object the object to check
* @throws IllegalArgumentException if the object is null
*/
public static void notNull(Object object) {
notNull(object, "The validated object is null");
}
/**
* Validate that the specified argument is not null;
* otherwise throwing an exception with the specified message.
*
*
Validate.notNull(myObject, "The object must not be null");
*
* @param object the object to check
* @param message the exception message if invalid
*/
public static void notNull(Object object, String message) {
if (object == null) {
throw new IllegalArgumentException(message);
}
}
// notEmpty array
//---------------------------------------------------------------------------------
/**
* Validate that the specified argument array is neither null
* nor a length of zero (no elements); otherwise throwing an exception
* with the specified message.
*
*
Validate.notEmpty(myArray, "The array must not be empty");
*
* @param array the array to check
* @param message the exception message if invalid
* @throws IllegalArgumentException if the array is empty
*/
public static void notEmpty(Object[] array, String message) {
if (array == null || array.length == 0) {
throw new IllegalArgumentException(message);
}
}
/**
* Validate that the specified argument array is neither null
* nor a length of zero (no elements); otherwise throwing an exception.
*
*
Validate.notEmpty(myArray);
*
* The message in the exception is "The validated array is
* empty".
*
* @param array the array to check
* @throws IllegalArgumentException if the array is empty
*/
public static void notEmpty(Object[] array) {
notEmpty(array, "The validated array is empty");
}
// notEmpty collection
//---------------------------------------------------------------------------------
/**
*
Validate that the specified argument collection is neither null
* nor a size of zero (no elements); otherwise throwing an exception
* with the specified message.
*
*
Validate.notEmpty(myCollection, "The collection must not be empty");
*
* @param collection the collection to check
* @param message the exception message if invalid
* @throws IllegalArgumentException if the collection is empty
*/
public static void notEmpty(Collection collection, String message) {
if (collection == null || collection.size() == 0) {
throw new IllegalArgumentException(message);
}
}
/**
* Validate that the specified argument collection is neither null
* nor a size of zero (no elements); otherwise throwing an exception.
*
*
Validate.notEmpty(myCollection);
*
* The message in the exception is "The validated collection is
* empty".
*
* @param collection the collection to check
* @throws IllegalArgumentException if the collection is empty
*/
public static void notEmpty(Collection collection) {
notEmpty(collection, "The validated collection is empty");
}
// notEmpty map
//---------------------------------------------------------------------------------
/**
* Validate that the specified argument map is neither null
* nor a size of zero (no elements); otherwise throwing an exception
* with the specified message.
*
*
Validate.notEmpty(myMap, "The map must not be empty");
*
* @param map the map to check
* @param message the exception message if invalid
* @throws IllegalArgumentException if the map is empty
*/
public static void notEmpty(Map map, String message) {
if (map == null || map.size() == 0) {
throw new IllegalArgumentException(message);
}
}
/**
* Validate that the specified argument map is neither null
* nor a size of zero (no elements); otherwise throwing an exception.
*
*
Validate.notEmpty(myMap);
*
* The message in the exception is "The validated map is
* empty".
*
* @param map the map to check
* @throws IllegalArgumentException if the map is empty
* @see #notEmpty(Map, String)
*/
public static void notEmpty(Map map) {
notEmpty(map, "The validated map is empty");
}
// notEmpty string
//---------------------------------------------------------------------------------
/**
* Validate that the specified argument string is
* neither null nor a length of zero (no characters);
* otherwise throwing an exception with the specified message.
*
*
Validate.notEmpty(myString, "The string must not be empty");
*
* @param string the string to check
* @param message the exception message if invalid
* @throws IllegalArgumentException if the string is empty
*/
public static void notEmpty(String string, String message) {
if (string == null || string.length() == 0) {
throw new IllegalArgumentException(message);
}
}
/**
* Validate that the specified argument string is
* neither null nor a length of zero (no characters);
* otherwise throwing an exception with the specified message.
*
*
Validate.notEmpty(myString);
*
* The message in the exception is "The validated
* string is empty".
*
* @param string the string to check
* @throws IllegalArgumentException if the string is empty
*/
public static void notEmpty(String string) {
notEmpty(string, "The validated string is empty");
}
// notNullElements array
//---------------------------------------------------------------------------------
/**
* Validate that the specified argument array is neither
* null nor contains any elements that are null;
* otherwise throwing an exception with the specified message.
*
*
Validate.noNullElements(myArray, "The array contain null at position %d");
*
* If the array is null, then the message in the exception
* is "The validated object is null".
*
* @param array the array to check
* @param message the exception message if the collection has null elements
* @throws IllegalArgumentException if the array is null or
* an element in the array is null
*/
public static void noNullElements(Object[] array, String message) {
Validate.notNull(array);
for (int i = 0; i < array.length; i++) {
if (array[i] == null) {
throw new IllegalArgumentException(message);
}
}
}
/**
* Validate that the specified argument array is neither
* null nor contains any elements that are null;
* otherwise throwing an exception.
*
*
Validate.noNullElements(myArray);
*
* If the array is null, then the message in the exception
* is "The validated object is null".
*
* If the array has a null element, then the message in the
* exception is "The validated array contains null element at index:
* " followed by the index.
*
* @param array the array to check
* @throws IllegalArgumentException if the array is null or
* an element in the array is null
*/
public static void noNullElements(Object[] array) {
Validate.notNull(array);
for (int i = 0; i < array.length; i++) {
if (array[i] == null) {
throw new IllegalArgumentException("The validated array contains null element at index: " + i);
}
}
}
// notNullElements collection
//---------------------------------------------------------------------------------
/**
* Validate that the specified argument collection is neither
* null nor contains any elements that are null;
* otherwise throwing an exception with the specified message.
*
*
Validate.noNullElements(myCollection, "The collection contains null elements");
*
* If the collection is null, then the message in the exception
* is "The validated object is null".
*
*
* @param collection the collection to check
* @param message the exception message if the collection has
* @throws IllegalArgumentException if the collection is null or
* an element in the collection is null
*/
public static void noNullElements(Collection collection, String message) {
Validate.notNull(collection);
for (Iterator it = collection.iterator(); it.hasNext();) {
if (it.next() == null) {
throw new IllegalArgumentException(message);
}
}
}
/**
* Validate that the specified argument collection is neither
* null nor contains any elements that are null;
* otherwise throwing an exception.
*
*
Validate.noNullElements(myCollection);
*
* If the collection is null, then the message in the exception
* is "The validated object is null".
*
* If the collection has a null element, then the message in the
* exception is "The validated collection contains null element at index:
* " followed by the index.
*
* @param collection the collection to check
* @throws IllegalArgumentException if the collection is null or
* an element in the collection is null
*/
public static void noNullElements(Collection collection) {
Validate.notNull(collection);
int i = 0;
for (Iterator it = collection.iterator(); it.hasNext(); i++) {
if (it.next() == null) {
throw new IllegalArgumentException("The validated collection contains null element at index: " + i);
}
}
}
/**
* Validate an argument, throwing IllegalArgumentException
* if the argument collection is null or has elements that
* are not of type clazz or a subclass.
*
*
* Validate.allElementsOfType(collection, String.class, "Collection has invalid elements");
*
*
* @param collection the collection to check, not null
* @param clazz the Class which the collection's elements are expected to be, not null
* @param message the exception message if the Collection has elements not of type clazz
* @since 2.1
*/
public static void allElementsOfType(Collection collection, Class clazz, String message) {
Validate.notNull(collection);
Validate.notNull(clazz);
for (Iterator it = collection.iterator(); it.hasNext(); ) {
if (clazz.isInstance(it.next()) == false) {
throw new IllegalArgumentException(message);
}
}
}
/**
*
* Validate an argument, throwing IllegalArgumentException if the argument collection is
* null or has elements that are not of type clazz 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: '.
*
*
* @param collection the collection to check, not null
* @param clazz the Class which the collection's elements are expected to be, not null
* @since 2.1
*/
public static void allElementsOfType(Collection collection, Class clazz) {
Validate.notNull(collection);
Validate.notNull(clazz);
int i = 0;
for (Iterator it = collection.iterator(); it.hasNext(); i++) {
if (clazz.isInstance(it.next()) == false) {
throw new IllegalArgumentException("The validated collection contains an element not of type "
+ clazz.getName() + " at index: " + i);
}
}
}
}