Package org.apache.hadoop.fs.impl.prefetch

Class Validate

java.lang.Object

org.apache.hadoop.fs.impl.prefetch.Validate

public final class Validate
extends java.lang.Object

A superset of Validate class in Apache commons lang3.

It provides consistent message strings for frequently encountered checks. That simplifies callers because they have to supply only the name of the argument that failed a check instead of having to supply the entire message.

Method Summary

Modifier and Type	Method	Description
static void	checkGreater(long value1, java.lang.String value1Name, long value2, java.lang.String value2Name)	Validates that the first value is greater than the second value.
static void	checkGreaterOrEqual(long value1, java.lang.String value1Name, long value2, java.lang.String value2Name)	Validates that the first value is greater than or equal to the second value.
static void	checkIntegerMultiple(long value1, java.lang.String value1Name, long value2, java.lang.String value2Name)	Validates that the first value is an integer multiple of the second value.
static void	checkLessOrEqual(long value1, java.lang.String value1Name, long value2, java.lang.String value2Name)	Validates that the first value is less than or equal to the second value.
static void	checkNotNegative(long value, java.lang.String argName)	Validates that the given integer argument is not negative.
static void	checkNotNull(java.lang.Object obj, java.lang.String argName)	Validates that the given reference argument is not null.
static void	checkNotNullAndNotEmpty(byte[] array, java.lang.String argName)	Validates that the given array is not null and has at least one element.
static void	checkNotNullAndNotEmpty(int[] array, java.lang.String argName)	Validates that the given array is not null and has at least one element.
static void	checkNotNullAndNotEmpty(long[] array, java.lang.String argName)	Validates that the given array is not null and has at least one element.
static void	checkNotNullAndNotEmpty(short[] array, java.lang.String argName)	Validates that the given array is not null and has at least one element.
static <T> void	checkNotNullAndNotEmpty(java.lang.Iterable<T> iter, java.lang.String argName)	Validates that the given buffer is not null and has non-zero capacity.
static void	checkNotNullAndNotEmpty(java.lang.String arg, java.lang.String argName)	Validates that the given string is not null and has non-zero length.
static <T> void	checkNotNullAndNotEmpty(T[] array, java.lang.String argName)	Validates that the given array is not null and has at least one element.
static <T> void	checkNotNullAndNumberOfElements(java.util.Collection<T> collection, int numElements, java.lang.String argName)	Validates that the given set is not null and has an exact number of items.
static void	checkPathExists(java.nio.file.Path path, java.lang.String argName)	Validates that the given path exists.
static void	checkPathExistsAsDir(java.nio.file.Path path, java.lang.String argName)	Validates that the given path exists and is a directory.
static void	checkPathExistsAsFile(java.nio.file.Path path, java.lang.String argName)	Validates that the given path exists and is a file.
static void	checkPositiveInteger(long value, java.lang.String argName)	Validates that the given integer argument is not zero or negative.
static void	checkRequired(boolean isPresent, java.lang.String argName)	Validates that the expression (that checks a required field is present) is true.
static void	checkState(boolean expression, java.lang.String format, java.lang.Object... args)	Check state.
static void	checkValid(boolean isValid, java.lang.String argName)	Validates that the expression (that checks a field is valid) is true.
static void	checkValid(boolean isValid, java.lang.String argName, java.lang.String validValues)	Validates that the expression (that checks a field is valid) is true.
static void	checkValuesEqual(long value1, java.lang.String value1Name, long value2, java.lang.String value2Name)	Validates that the given two values are equal.
static void	checkWithinRange(double value, java.lang.String valueName, double minValueInclusive, double maxValueInclusive)	Validates that the given value is within the given range of values.
static void	checkWithinRange(long value, java.lang.String valueName, long minValueInclusive, long maxValueInclusive)	Validates that the given value is within the given range of values.

Methods inherited from class java.lang.Object

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

Method Detail

checkNotNull

public static void checkNotNull(java.lang.Object obj,
                                java.lang.String argName)

Validates that the given reference argument is not null.

Parameters:

obj - the argument reference to validate.

argName - the name of the argument being validated.

checkPositiveInteger

public static void checkPositiveInteger(long value,
                                        java.lang.String argName)

Validates that the given integer argument is not zero or negative.

Parameters:

value - the argument value to validate

argName - the name of the argument being validated.

checkNotNegative

public static void checkNotNegative(long value,
                                    java.lang.String argName)

Validates that the given integer argument is not negative.

Parameters:

value - the argument value to validate

argName - the name of the argument being validated.

checkRequired

public static void checkRequired(boolean isPresent,
                                 java.lang.String argName)

Validates that the expression (that checks a required field is present) is true.

Parameters:

isPresent - indicates whether the given argument is present.

argName - the name of the argument being validated.

checkValid

public static void checkValid(boolean isValid,
                              java.lang.String argName)

Validates that the expression (that checks a field is valid) is true.

Parameters:

isValid - indicates whether the given argument is valid.

argName - the name of the argument being validated.

checkValid

public static void checkValid(boolean isValid,
                              java.lang.String argName,
                              java.lang.String validValues)

Validates that the expression (that checks a field is valid) is true.

Parameters:

isValid - indicates whether the given argument is valid.

argName - the name of the argument being validated.

validValues - the list of values that are allowed.

checkNotNullAndNotEmpty

public static void checkNotNullAndNotEmpty(java.lang.String arg,
                                           java.lang.String argName)

Validates that the given string is not null and has non-zero length.

Parameters:

arg - the argument reference to validate.

argName - the name of the argument being validated.

checkNotNullAndNotEmpty

public static <T> void checkNotNullAndNotEmpty(T[] array,
                                               java.lang.String argName)

Validates that the given array is not null and has at least one element.

Type Parameters:

T - the type of array's elements.

Parameters:

array - the argument reference to validate.

argName - the name of the argument being validated.

checkNotNullAndNotEmpty

public static void checkNotNullAndNotEmpty(byte[] array,
                                           java.lang.String argName)

Validates that the given array is not null and has at least one element.

Parameters:

array - the argument reference to validate.

argName - the name of the argument being validated.

checkNotNullAndNotEmpty

public static void checkNotNullAndNotEmpty(short[] array,
                                           java.lang.String argName)

Validates that the given array is not null and has at least one element.

Parameters:

array - the argument reference to validate.

argName - the name of the argument being validated.

checkNotNullAndNotEmpty

public static void checkNotNullAndNotEmpty(int[] array,
                                           java.lang.String argName)

Validates that the given array is not null and has at least one element.

Parameters:

array - the argument reference to validate.

argName - the name of the argument being validated.

checkNotNullAndNotEmpty

public static void checkNotNullAndNotEmpty(long[] array,
                                           java.lang.String argName)

Validates that the given array is not null and has at least one element.

Parameters:

array - the argument reference to validate.

argName - the name of the argument being validated.

checkNotNullAndNotEmpty

public static <T> void checkNotNullAndNotEmpty(java.lang.Iterable<T> iter,
                                               java.lang.String argName)

Validates that the given buffer is not null and has non-zero capacity.

Type Parameters:

T - the type of iterable's elements.

Parameters:

iter - the argument reference to validate.

argName - the name of the argument being validated.

checkNotNullAndNumberOfElements

public static <T> void checkNotNullAndNumberOfElements(java.util.Collection<T> collection,
                                                       int numElements,
                                                       java.lang.String argName)

Validates that the given set is not null and has an exact number of items.

Type Parameters:

T - the type of collection's elements.

Parameters:

collection - the argument reference to validate.

numElements - the expected number of elements in the collection.

argName - the name of the argument being validated.

checkValuesEqual

public static void checkValuesEqual(long value1,
                                    java.lang.String value1Name,
                                    long value2,
                                    java.lang.String value2Name)

Validates that the given two values are equal.

Parameters:

value1 - the first value to check.

value1Name - the name of the first argument.

value2 - the second value to check.

value2Name - the name of the second argument.

checkIntegerMultiple

public static void checkIntegerMultiple(long value1,
                                        java.lang.String value1Name,
                                        long value2,
                                        java.lang.String value2Name)

Validates that the first value is an integer multiple of the second value.

Parameters:

value1 - the first value to check.

value1Name - the name of the first argument.

value2 - the second value to check.

value2Name - the name of the second argument.

checkGreater

public static void checkGreater(long value1,
                                java.lang.String value1Name,
                                long value2,
                                java.lang.String value2Name)

Validates that the first value is greater than the second value.

Parameters:

value1 - the first value to check.

value1Name - the name of the first argument.

value2 - the second value to check.

value2Name - the name of the second argument.

checkGreaterOrEqual

public static void checkGreaterOrEqual(long value1,
                                       java.lang.String value1Name,
                                       long value2,
                                       java.lang.String value2Name)

Validates that the first value is greater than or equal to the second value.

Parameters:

value1 - the first value to check.

value1Name - the name of the first argument.

value2 - the second value to check.

value2Name - the name of the second argument.

checkLessOrEqual

public static void checkLessOrEqual(long value1,
                                    java.lang.String value1Name,
                                    long value2,
                                    java.lang.String value2Name)

Validates that the first value is less than or equal to the second value.

Parameters:

value1 - the first value to check.

value1Name - the name of the first argument.

value2 - the second value to check.

value2Name - the name of the second argument.

checkWithinRange

public static void checkWithinRange(long value,
                                    java.lang.String valueName,
                                    long minValueInclusive,
                                    long maxValueInclusive)

Validates that the given value is within the given range of values.

Parameters:

value - the value to check.

valueName - the name of the argument.

minValueInclusive - inclusive lower limit for the value.

maxValueInclusive - inclusive upper limit for the value.

checkWithinRange

public static void checkWithinRange(double value,
                                    java.lang.String valueName,
                                    double minValueInclusive,
                                    double maxValueInclusive)

Validates that the given value is within the given range of values.

Parameters:

value - the value to check.

valueName - the name of the argument.

minValueInclusive - inclusive lower limit for the value.

maxValueInclusive - inclusive upper limit for the value.

checkPathExists

public static void checkPathExists(java.nio.file.Path path,
                                   java.lang.String argName)

Validates that the given path exists.

Parameters:

path - the path to check.

argName - the name of the argument being validated.

checkPathExistsAsDir

public static void checkPathExistsAsDir(java.nio.file.Path path,
                                        java.lang.String argName)

Validates that the given path exists and is a directory.

Parameters:

path - the path to check.

argName - the name of the argument being validated.

checkPathExistsAsFile

public static void checkPathExistsAsFile(java.nio.file.Path path,
                                         java.lang.String argName)

Validates that the given path exists and is a file.

Parameters:

path - the path to check.

argName - the name of the argument being validated.

checkState

public static void checkState(boolean expression,
                              java.lang.String format,
                              java.lang.Object... args)

Check state.

Parameters:

expression - expression which must hold.

format - format string

args - arguments for the error string

Throws:

java.lang.IllegalStateException - if the state is not valid.