org.gatein.common.util

Class ParameterValidation

java.lang.Object

org.gatein.common.util.ParameterValidation

public class ParameterValidation
extends Object

Since:

2.4 (May 31, 2009)

Version:

$Revision: 5757 $

Author:

Chris Laprun

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ParameterValidation.LoggingValidationErrorHandler
static class	ParameterValidation.ValidationErrorHandler Implements a behavior to be executed in case a value fails to be validated.

Field Summary

Fields

Modifier and Type	Field and Description
static Pattern	CSS_DISTANCE
static Pattern	VALID_ASCII_CLASS_NAME
static Pattern	XSS_CHECK

Constructor Summary

Constructors

Constructor and Description
ParameterValidation()

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	existsAndIsNotEmpty(Collection collection)
static boolean	existsAndIsNotEmpty(Map map)
static <T> boolean	existsAndIsNotEmpty(T[] array)
static boolean	isNullOrEmpty(String valueToCheck) Determines whether the given String is null or empty (after all extra whitespaces have been trimmed, if any).
static boolean	isOldAndNewDifferent(Object oldValue, Object newValue)
static String	sanitizeFromPattern(String value, Pattern regex, String defaultValue) Checks if a given value matches the given format (as a regular expression).
static String	sanitizeFromPatternWithHandler(String value, Pattern regex, ParameterValidation.ValidationErrorHandler handler) Checks if a given value matches the given format (as a regular expression) and delegates what to do to the specified ValidationErrorHandler.
static String	sanitizeFromValues(String value, String[] possibleValues, String defaultValue) Checks if a given value matches one of the possible values.
static String	sanitizeFromValuesWithHandler(String value, String[] possibleValues, ParameterValidation.ValidationErrorHandler handler) Checks if a given value matches one of the possible values and delegates what to do to the specified ValidationErrorHandler.
static void	throwIllegalArgExceptionIfNull(Object objectToTest, String name)
static void	throwIllegalArgExceptionIfNullOrEmpty(Object[] array, String name)
static void	throwIllegalArgExceptionIfNullOrEmpty(String valueToCheck, String valueName, String contextName)
static void	throwIllegalArgExceptionIfRangeInvalid(char[] chars, int offset, int length)

Methods inherited from class java.lang.Object

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

Field Detail

CSS_DISTANCE

public static final Pattern CSS_DISTANCE

XSS_CHECK

public static final Pattern XSS_CHECK

VALID_ASCII_CLASS_NAME

public static final Pattern VALID_ASCII_CLASS_NAME

Constructor Detail

ParameterValidation

public ParameterValidation()

Method Detail

throwIllegalArgExceptionIfNullOrEmpty

public static void throwIllegalArgExceptionIfNullOrEmpty(String valueToCheck,
                                         String valueName,
                                         String contextName)

throwIllegalArgExceptionIfRangeInvalid

public static void throwIllegalArgExceptionIfRangeInvalid(char[] chars,
                                          int offset,
                                          int length)

isNullOrEmpty

public static boolean isNullOrEmpty(String valueToCheck)

Determines whether the given String is null or empty (after all extra whitespaces have been trimmed, if any).

Parameters:

valueToCheck - the String to test

Returns:

true if the the given String is null or empty (after being trimmed), false otherwise.

throwIllegalArgExceptionIfNull

public static void throwIllegalArgExceptionIfNull(Object objectToTest,
                                  String name)

throwIllegalArgExceptionIfNullOrEmpty

public static void throwIllegalArgExceptionIfNullOrEmpty(Object[] array,
                                         String name)

Since:

2.4.1

existsAndIsNotEmpty

public static boolean existsAndIsNotEmpty(Collection collection)

existsAndIsNotEmpty

public static boolean existsAndIsNotEmpty(Map map)

existsAndIsNotEmpty

public static <T> boolean existsAndIsNotEmpty(T[] array)

isOldAndNewDifferent

public static boolean isOldAndNewDifferent(Object oldValue,
                           Object newValue)

sanitizeFromPattern

public static String sanitizeFromPattern(String value,
                         Pattern regex,
                         String defaultValue)

Checks if a given value matches the given format (as a regular expression). If yes, returns it as is. Otherwise, returns the default value.

Parameters:

value - value to sanitize if needed, null is considered as not matching

regex - format the value needs to conform to

defaultValue - default value to use if the specified value does not conform to the specified format

Returns:

the specified value if it conforms to the expected format, the given default value otherwise.

sanitizeFromPatternWithHandler

public static String sanitizeFromPatternWithHandler(String value,
                                    Pattern regex,
                                    ParameterValidation.ValidationErrorHandler handler)

Checks if a given value matches the given format (as a regular expression) and delegates what to do to the specified ValidationErrorHandler.

Parameters:

value - value to sanitize if needed, null is considered as not matching

regex - format the value needs to conform to

handler - ValidationErrorHandler implementing the behavior to apply in case the specified value failed to validate

Returns:

the specified value if it conforms to the expected format, whatever value the specified ValidationErrorHandler thinks appropriate otherwise.

sanitizeFromValues

public static String sanitizeFromValues(String value,
                        String[] possibleValues,
                        String defaultValue)

Checks if a given value matches one of the possible values. If yes, returns it as is. Otherwise, returns the default value.

Parameters:

value - value to sanitize if needed, null is considered as not matching

possibleValues - possible values

defaultValue - default value to use if the specified value does not conform to the specified format

Returns:

the specified value if it conforms to the expected format, the given default value otherwise.

sanitizeFromValuesWithHandler

public static String sanitizeFromValuesWithHandler(String value,
                                   String[] possibleValues,
                                   ParameterValidation.ValidationErrorHandler handler)

Checks if a given value matches one of the possible values and delegates what to do to the specified ValidationErrorHandler.

Parameters:

value - value to sanitize if needed, null is considered as not matching

possibleValues - possible values

handler - ValidationErrorHandler implementing the behavior to apply in case the specified value failed to validate

Returns:

the specified value if it conforms to the expected format, whatever value the specified ValidationErrorHandler thinks appropriate otherwise.