org.apache.oozie.util

Class ParamChecker

java.lang.Object

org.apache.oozie.util.ParamChecker

public class ParamChecker
extends java.lang.Object

Utility class to check common parameter preconditions.

Constructor Summary

Constructors

Constructor and Description
ParamChecker()

Method Summary

Methods

Modifier and Type	Method and Description
static java.util.Date	checkDateOozieTZ(java.lang.String date, java.lang.String name) Check whether the value is Oozie processing timezone data format.
static java.lang.String	checkFrequency(java.lang.String val) Check whether a value is a valid coordinator frequency.
static int	checkGEZero(int value, java.lang.String name) Check whether the value is greater than or equals to 0.
static int	checkGTZero(int value, java.lang.String name) Check whether the value is greater than or equals 0.
static int	checkInteger(java.lang.String val, java.lang.String name) Check whether the value is Integer.
static int	checkLEZero(int value, java.lang.String name) Check whether the value is less than or equal to 0.
static java.util.TimeZone	checkTimeZone(java.lang.String tzStr, java.lang.String name) Check whether the value mention correct Timezone.
static boolean	isMember(java.lang.String item, java.lang.String[] members, java.lang.String name) Check whether an item is a member of an array of string
static boolean	isValidIdentifier(java.lang.String token) Return if the specified token is a valid Java identifier.
static java.lang.String	notEmpty(java.lang.String str, java.lang.String name) Check that a string is not null and not empty.
static java.lang.String	notEmpty(java.lang.String str, java.lang.String name, java.lang.String info) Check that a string is not null and not empty.
static java.util.List<java.lang.String>	notEmptyElements(java.util.List<java.lang.String> list, java.lang.String name) Check that a list is not null and that none of its elements is null.
static <T> T	notNull(T obj, java.lang.String name) Check that a value is not null.
static <T> java.util.List<T>	notNullElements(java.util.List<T> list, java.lang.String name) Check that a list is not null and that none of its elements is null.
static java.lang.String	validateActionName(java.lang.String actionName) Check that the given string is a valid action name [a-zA-Z_][0-9a-zA-Z_\-]* and not longer than 128 chars.

Methods inherited from class java.lang.Object

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

Constructor Detail

ParamChecker

public ParamChecker()

Method Detail

notNull

public static <T> T notNull(T obj,
            java.lang.String name)

Check that a value is not null. If null throws an IllegalArgumentException.

Parameters:

obj - value.

name - parameter name for the exception message.

Returns:

the given value.

notNullElements

public static <T> java.util.List<T> notNullElements(java.util.List<T> list,
                                    java.lang.String name)

Check that a list is not null and that none of its elements is null. If null or if the list has emtpy elements throws an IllegalArgumentException.

Parameters:

list - the list of strings.

name - parameter name for the exception message.

Returns:

the given list.

notEmpty

public static java.lang.String notEmpty(java.lang.String str,
                        java.lang.String name)

Check that a string is not null and not empty. If null or emtpy throws an IllegalArgumentException.

Parameters:

str - value.

name - parameter name for the exception message.

Returns:

the given value.

notEmpty

public static java.lang.String notEmpty(java.lang.String str,
                        java.lang.String name,
                        java.lang.String info)

Check that a string is not null and not empty. If null or emtpy throws an IllegalArgumentException.

Parameters:

str - value.

name - parameter name for the exception message.

info - additional information to be printed with the exception message

Returns:

the given value.

notEmptyElements

public static java.util.List<java.lang.String> notEmptyElements(java.util.List<java.lang.String> list,
                                                java.lang.String name)

Check that a list is not null and that none of its elements is null. If null or if the list has emtpy elements throws an IllegalArgumentException.

Parameters:

list - the list of strings.

name - parameter name for the exception message.

Returns:

the given list.

validateActionName

public static java.lang.String validateActionName(java.lang.String actionName)

Check that the given string is a valid action name [a-zA-Z_][0-9a-zA-Z_\-]* and not longer than 128 chars.

Parameters:

actionName - string to validate is a token.

Returns:

the given string.

isValidIdentifier

public static boolean isValidIdentifier(java.lang.String token)

Return if the specified token is a valid Java identifier.

Parameters:

token - string to validate if it is a valid Java identifier.

Returns:

if the specified token is a valid Java identifier.

checkGTZero

public static int checkGTZero(int value,
              java.lang.String name)

Check whether the value is greater than or equals 0.

Parameters:

value - : value to test

name - : Name of the parameter

Returns:

If the value is > 0, return the value. Otherwise throw IllegalArgumentException

checkGEZero

public static int checkGEZero(int value,
              java.lang.String name)

Check whether the value is greater than or equals to 0.

Parameters:

value - : value to test

name - : Name of the parameter

Returns:

If the value is >= 0, return the value. Otherwise throw IllegalArgumentException

checkLEZero

public static int checkLEZero(int value,
              java.lang.String name)

Check whether the value is less than or equal to 0.

Parameters:

value - : value to test

name - : Name of the parameter

Returns:

If the value is <= 0, return the value. Otherwise throw IllegalArgumentException

checkInteger

public static int checkInteger(java.lang.String val,
               java.lang.String name)

Check whether the value is Integer.

Parameters:

value - : value to test

name - : Name of the parameter

Returns:

If the value is integer, return the value. Otherwise throw IllegalArgumentException

checkFrequency

public static java.lang.String checkFrequency(java.lang.String val)

Check whether a value is a valid coordinator frequency.

Parameters:

value - : value to test

Returns:

If the value is a valid frequency, return the frequency, Otherwise throw IllegalArgumentException

checkDateOozieTZ

public static java.util.Date checkDateOozieTZ(java.lang.String date,
                              java.lang.String name)

Check whether the value is Oozie processing timezone data format.

Parameters:

value - : value to test

name - : Name of the parameter

Returns:

If the value is in Oozie processing timezone date format, return the value. Otherwise throw IllegalArgumentException

checkTimeZone

public static java.util.TimeZone checkTimeZone(java.lang.String tzStr,
                               java.lang.String name)

Check whether the value mention correct Timezone.

Parameters:

value - : value to test

name - : Name of the parameter

Returns:

If the value is correct TZ return the value. Otherwise throw IllegalArgumentException

isMember

public static boolean isMember(java.lang.String item,
               java.lang.String[] members,
               java.lang.String name)

Check whether an item is a member of an array of string

Parameters:

item - : item to test

members - : List of items in string

name - : Name of the parameter

Returns:

If the item is in the member return true. Otherwise throw IllegalArgumentException