Class 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

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static void checkArgument​(boolean expression, java.lang.String format, java.lang.Object... args)  
      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)  
      static void checkPathExistsAsDir​(java.nio.file.Path path, java.lang.String argName)  
      static void checkPathExistsAsFile​(java.nio.file.Path path, java.lang.String argName)  
      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)  
      static void checkState​(boolean expression, java.lang.String format, java.lang.Object... args)  
      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.
      • checkPositiveInteger

        public static void checkPositiveInteger​(long value,
                                                java.lang.String argName)
        Validates that the given integer argument is not zero or negative.
      • checkNotNegative

        public static void checkNotNegative​(long value,
                                            java.lang.String argName)
        Validates that the given integer argument is not negative.
      • checkRequired

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

        public static void checkValid​(boolean isValid,
                                      java.lang.String argName)
        Validates that the expression (that checks a field is valid) is true.
      • 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.
      • 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.
      • 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.
      • 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.
      • 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.
      • 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.
      • 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.
      • 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.
      • 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.
      • 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.
      • 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.
      • 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.
      • 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.
      • 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.
      • 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.
      • 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.
      • checkPathExists

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

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

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

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

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