org.waarp.common.utility

Class ParametersChecker

java.lang.Object

org.waarp.common.utility.ParametersChecker

public final class ParametersChecker
extends Object

Checker for Parameters

Can be used for String (testing also emptiness) and for general Object.
For null String only, use the special method.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_ERROR
static Pattern	HTML_PATTERN
static List<String>	RULES
static Pattern	UNPRINTABLE_PATTERN
static String[]	ZERO_ARRAY_STRING

Method Summary

Modifier and Type	Method and Description
static void	checkParameter(String errorMessage, Object... parameters) Check if any parameter are null and if so, throw an IllegalArgumentException
static void	checkParameter(String errorMessage, String... parameters) Check if any parameter are null or empty and if so, throw an IllegalArgumentException
static void	checkParameterDefault(String errorMessage, Object... parameters) Check if any parameter are null or empty and if so, throw an IllegalArgumentException
static void	checkParameterDefault(String errorMessage, String... parameters) Check if any parameter are null or empty and if so, throw an IllegalArgumentException
static void	checkParameterNullOnly(String errorMessage, String... parameters) Check if any parameter are null and if so, throw an IllegalArgumentException
static void	checkSanityString(String... strings) Check external argument (null is consider as correct)
static String	checkSanityString(String value) Check external argument to avoid Path Traversal attack
static void	checkValue(String name, long variable, long minValue) Check if an integer parameter is greater or equals to minValue
static boolean	isEmpty(String... parameters) Check if any parameter are null or empty and if so, return true
static boolean	isNotEmpty(String... parameters) Check if any parameter are null or empty and if so, return false

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ERROR

public static final String DEFAULT_ERROR

See Also:

Constant Field Values

UNPRINTABLE_PATTERN

public static final Pattern UNPRINTABLE_PATTERN

RULES

public static final List<String> RULES

ZERO_ARRAY_STRING

public static final String[] ZERO_ARRAY_STRING

HTML_PATTERN

public static final Pattern HTML_PATTERN

Method Detail

checkParameter

public static void checkParameter(String errorMessage,
                                  String... parameters)

Check if any parameter are null or empty and if so, throw an IllegalArgumentException

Parameters:

errorMessage - the error message

parameters - parameters to be checked

Throws:

IllegalArgumentException - if null or empty

checkParameterDefault

public static void checkParameterDefault(String errorMessage,
                                         String... parameters)

Check if any parameter are null or empty and if so, throw an IllegalArgumentException

Parameters:

errorMessage - the error message

parameters - set of parameters

Throws:

IllegalArgumentException - if null or empty

isNotEmpty

public static boolean isNotEmpty(String... parameters)

Check if any parameter are null or empty and if so, return false

Parameters:

parameters - set of parameters

Returns:

True if not null and not empty neither containing only spaces

isEmpty

public static boolean isEmpty(String... parameters)

Check if any parameter are null or empty and if so, return true

Parameters:

parameters - set of parameters

Returns:

True if any is null or empty or containing only spaces

checkParameterDefault

public static void checkParameterDefault(String errorMessage,
                                         Object... parameters)

Check if any parameter are null or empty and if so, throw an IllegalArgumentException

Parameters:

errorMessage - the error message

parameters - set of parameters

Throws:

IllegalArgumentException - if null or empty

checkParameterNullOnly

public static void checkParameterNullOnly(String errorMessage,
                                          String... parameters)

Check if any parameter are null and if so, throw an IllegalArgumentException

Parameters:

errorMessage - the error message

parameters - parameters to be checked

Throws:

IllegalArgumentException - if null

checkParameter

public static void checkParameter(String errorMessage,
                                  Object... parameters)

Check if any parameter are null and if so, throw an IllegalArgumentException

Parameters:

errorMessage - set of parameters

parameters - set parameters to be checked

Throws:

IllegalArgumentException - if null

checkValue

public static void checkValue(String name,
                              long variable,
                              long minValue)

Check if an integer parameter is greater or equals to minValue

Parameters:

name - name of the variable

variable - the value of variable to check

minValue - the min value

checkSanityString

public static String checkSanityString(String value)
                                throws InvalidArgumentException

Check external argument to avoid Path Traversal attack

Parameters:

value - to check

Throws:

InvalidArgumentException

checkSanityString

public static void checkSanityString(String... strings)
                              throws InvalidArgumentException

Check external argument (null is consider as correct)

Parameters:

strings -

Throws:

InvalidArgumentException