Class Validator

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static void ensureFalse​(boolean condition)
      Ensures that the provided condition is false.
      static void ensureFalse​(boolean condition, java.lang.String message)
      Ensures that the provided condition is false.
      static void ensureNotNull​(java.lang.Object o)
      Ensures that the provided object is not null.
      static void ensureNotNull​(java.lang.Object o1, java.lang.Object o2)
      Ensures that none of the provided objects is null.
      static void ensureNotNull​(java.lang.Object o1, java.lang.Object o2, java.lang.Object o3)
      Ensures that none of the provided objects is null.
      static void ensureNotNull​(java.lang.Object o1, java.lang.Object o2, java.lang.Object o3, java.lang.Object o4)
      Ensures that none of the provided objects is null.
      static void ensureNotNull​(java.lang.Object o1, java.lang.Object o2, java.lang.Object o3, java.lang.Object o4, java.lang.Object o5)
      Ensures that none of the provided objects is null.
      static void ensureNotNullOrEmpty​(byte[] array)
      Ensures that the provided array is not null and has a length of at least one.
      static void ensureNotNullOrEmpty​(byte[] array, java.lang.String message)
      Ensures that the provided array is not null and has a length of at least one.
      static void ensureNotNullOrEmpty​(char[] array)
      Ensures that the provided array is not null and has a length of at least one.
      static void ensureNotNullOrEmpty​(char[] array, java.lang.String message)
      Ensures that the provided array is not null and has a length of at least one.
      static void ensureNotNullOrEmpty​(int[] array)
      Ensures that the provided array is not null and has a length of at least one.
      static void ensureNotNullOrEmpty​(int[] array, java.lang.String message)
      Ensures that the provided array is not null and has a length of at least one.
      static void ensureNotNullOrEmpty​(long[] array)
      Ensures that the provided array is not null and has a length of at least one.
      static void ensureNotNullOrEmpty​(long[] array, java.lang.String message)
      Ensures that the provided array is not null and has a length of at least one.
      static void ensureNotNullOrEmpty​(java.lang.CharSequence charSequence)
      Ensures that the provided character sequence is not null and has a length of at least one.
      static void ensureNotNullOrEmpty​(java.lang.CharSequence charSequence, java.lang.String message)
      Ensures that the provided character sequence is not null and has a length of at least one.
      static void ensureNotNullOrEmpty​(java.lang.Object[] array)
      Ensures that the provided array is not null and has a length of at least one.
      static void ensureNotNullOrEmpty​(java.lang.Object[] array, java.lang.String message)
      Ensures that the provided array is not null and has a length of at least one.
      static void ensureNotNullOrEmpty​(java.util.Collection<?> collection)
      Ensures that the provided collection is not null and contains at least one item.
      static void ensureNotNullOrEmpty​(java.util.Collection<?> collection, java.lang.String message)
      Ensures that the provided collection is not null and contains at least one item.
      static void ensureNotNullOrEmpty​(java.util.Map<?,​?> map)
      Ensures that the provided map is not null and contains at least one item.
      static void ensureNotNullOrEmpty​(java.util.Map<?,​?> map, java.lang.String message)
      Ensures that the provided map is not null and contains at least one item.
      static void ensureNotNullWithMessage​(java.lang.Object o, java.lang.String message)
      Ensures that the provided object is not null.
      static void ensureTrue​(boolean condition)
      Ensures that the provided condition is true.
      static void ensureTrue​(boolean condition, java.lang.String message)
      Ensures that the provided condition is true.
      static void violation​(java.lang.String message)
      Indicates that an expected condition was not true by throwing an LDAPSDKUsageException with the provided information.
      static void violation​(java.lang.String message, java.lang.Throwable cause)
      Indicates that an expected condition was not true by throwing an LDAPSDKUsageException with the provided information.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Method Detail

      • ensureNotNullWithMessage

        public static void ensureNotNullWithMessage​(java.lang.Object o,
                                                    java.lang.String message)
                                             throws LDAPSDKUsageException
        Ensures that the provided object is not null.
        Parameters:
        o - The object to examine.
        message - The message to include in the exception thrown if the provided object is null.
        Throws:
        LDAPSDKUsageException - If the provided object is null.
      • ensureNotNull

        public static void ensureNotNull​(java.lang.Object o1,
                                         java.lang.Object o2)
                                  throws LDAPSDKUsageException
        Ensures that none of the provided objects is null.
        Parameters:
        o1 - The first object for which to make the determination.
        o2 - The second object for which to make the determination.
        Throws:
        LDAPSDKUsageException - If any of the provided objects is null.
      • ensureNotNull

        public static void ensureNotNull​(java.lang.Object o1,
                                         java.lang.Object o2,
                                         java.lang.Object o3)
                                  throws LDAPSDKUsageException
        Ensures that none of the provided objects is null.
        Parameters:
        o1 - The first object for which to make the determination.
        o2 - The second object for which to make the determination.
        o3 - The third object for which to make the determination.
        Throws:
        LDAPSDKUsageException - If any of the provided objects is null.
      • ensureNotNull

        public static void ensureNotNull​(java.lang.Object o1,
                                         java.lang.Object o2,
                                         java.lang.Object o3,
                                         java.lang.Object o4)
                                  throws LDAPSDKUsageException
        Ensures that none of the provided objects is null.
        Parameters:
        o1 - The first object for which to make the determination.
        o2 - The second object for which to make the determination.
        o3 - The third object for which to make the determination.
        o4 - The fourth object for which to make the determination.
        Throws:
        LDAPSDKUsageException - If any of the provided objects is null.
      • ensureNotNull

        public static void ensureNotNull​(java.lang.Object o1,
                                         java.lang.Object o2,
                                         java.lang.Object o3,
                                         java.lang.Object o4,
                                         java.lang.Object o5)
                                  throws LDAPSDKUsageException
        Ensures that none of the provided objects is null.
        Parameters:
        o1 - The first object for which to make the determination.
        o2 - The second object for which to make the determination.
        o3 - The third object for which to make the determination.
        o4 - The fourth object for which to make the determination.
        o5 - The fifth object for which to make the determination.
        Throws:
        LDAPSDKUsageException - If any of the provided objects is null.
      • ensureNotNullOrEmpty

        public static void ensureNotNullOrEmpty​(java.util.Collection<?> collection)
        Ensures that the provided collection is not null and contains at least one item.
        Parameters:
        collection - The collection to verify.
        Throws:
        LDAPSDKUsageException - If the provided collection is null or empty.
      • ensureNotNullOrEmpty

        public static void ensureNotNullOrEmpty​(java.util.Collection<?> collection,
                                                java.lang.String message)
        Ensures that the provided collection is not null and contains at least one item.
        Parameters:
        collection - The collection to verify.
        message - The message to include in the exception thrown if the provided collection is null or empty.
        Throws:
        LDAPSDKUsageException - If the provided collection is null or empty.
      • ensureNotNullOrEmpty

        public static void ensureNotNullOrEmpty​(java.util.Map<?,​?> map)
        Ensures that the provided map is not null and contains at least one item.
        Parameters:
        map - The map to verify.
        Throws:
        LDAPSDKUsageException - If the provided map is null or empty.
      • ensureNotNullOrEmpty

        public static void ensureNotNullOrEmpty​(java.util.Map<?,​?> map,
                                                java.lang.String message)
        Ensures that the provided map is not null and contains at least one item.
        Parameters:
        map - The map to verify.
        message - The message to include in the exception thrown if the provided map is null or empty.
        Throws:
        LDAPSDKUsageException - If the provided map is null or empty.
      • ensureNotNullOrEmpty

        public static void ensureNotNullOrEmpty​(java.lang.Object[] array)
        Ensures that the provided array is not null and has a length of at least one.
        Parameters:
        array - The array to verify.
        Throws:
        LDAPSDKUsageException - If the provided array is null or empty.
      • ensureNotNullOrEmpty

        public static void ensureNotNullOrEmpty​(java.lang.Object[] array,
                                                java.lang.String message)
        Ensures that the provided array is not null and has a length of at least one.
        Parameters:
        array - The array to verify.
        message - The message to include in the exception thrown if the provided array is null or empty.
        Throws:
        LDAPSDKUsageException - If the provided array is null or empty.
      • ensureNotNullOrEmpty

        public static void ensureNotNullOrEmpty​(byte[] array)
        Ensures that the provided array is not null and has a length of at least one.
        Parameters:
        array - The array to verify.
        Throws:
        LDAPSDKUsageException - If the provided array is null or empty.
      • ensureNotNullOrEmpty

        public static void ensureNotNullOrEmpty​(byte[] array,
                                                java.lang.String message)
        Ensures that the provided array is not null and has a length of at least one.
        Parameters:
        array - The array to verify.
        message - The message to include in the exception thrown if the provided array is null or empty.
        Throws:
        LDAPSDKUsageException - If the provided array is null or empty.
      • ensureNotNullOrEmpty

        public static void ensureNotNullOrEmpty​(char[] array)
        Ensures that the provided array is not null and has a length of at least one.
        Parameters:
        array - The array to verify.
        Throws:
        LDAPSDKUsageException - If the provided array is null or empty.
      • ensureNotNullOrEmpty

        public static void ensureNotNullOrEmpty​(char[] array,
                                                java.lang.String message)
        Ensures that the provided array is not null and has a length of at least one.
        Parameters:
        array - The array to verify.
        message - The message to include in the exception thrown if the provided array is null or empty.
        Throws:
        LDAPSDKUsageException - If the provided array is null or empty.
      • ensureNotNullOrEmpty

        public static void ensureNotNullOrEmpty​(int[] array)
        Ensures that the provided array is not null and has a length of at least one.
        Parameters:
        array - The array to verify.
        Throws:
        LDAPSDKUsageException - If the provided array is null or empty.
      • ensureNotNullOrEmpty

        public static void ensureNotNullOrEmpty​(int[] array,
                                                java.lang.String message)
        Ensures that the provided array is not null and has a length of at least one.
        Parameters:
        array - The array to verify.
        message - The message to include in the exception thrown if the provided array is null or empty.
        Throws:
        LDAPSDKUsageException - If the provided array is null or empty.
      • ensureNotNullOrEmpty

        public static void ensureNotNullOrEmpty​(long[] array)
        Ensures that the provided array is not null and has a length of at least one.
        Parameters:
        array - The array to verify.
        Throws:
        LDAPSDKUsageException - If the provided array is null or empty.
      • ensureNotNullOrEmpty

        public static void ensureNotNullOrEmpty​(long[] array,
                                                java.lang.String message)
        Ensures that the provided array is not null and has a length of at least one.
        Parameters:
        array - The array to verify.
        message - The message to include in the exception thrown if the provided array is null or empty.
        Throws:
        LDAPSDKUsageException - If the provided array is null or empty.
      • ensureNotNullOrEmpty

        public static void ensureNotNullOrEmpty​(java.lang.CharSequence charSequence)
        Ensures that the provided character sequence is not null and has a length of at least one.
        Parameters:
        charSequence - The character sequence to verify.
        Throws:
        LDAPSDKUsageException - If the provided character sequence is null or empty.
      • ensureNotNullOrEmpty

        public static void ensureNotNullOrEmpty​(java.lang.CharSequence charSequence,
                                                java.lang.String message)
        Ensures that the provided character sequence is not null and has a length of at least one.
        Parameters:
        charSequence - The character sequence to verify.
        message - The message to include in the exception thrown if the provided character sequence is null or empty.
        Throws:
        LDAPSDKUsageException - If the provided character sequence is null or empty.
      • ensureTrue

        public static void ensureTrue​(boolean condition,
                                      java.lang.String message)
                               throws LDAPSDKUsageException
        Ensures that the provided condition is true.
        Parameters:
        condition - The condition to verify.
        message - The message to include in the exception thrown if the provided object is null.
        Throws:
        LDAPSDKUsageException - If the provided condition is false.
      • ensureFalse

        public static void ensureFalse​(boolean condition,
                                       java.lang.String message)
                                throws LDAPSDKUsageException
        Ensures that the provided condition is false.
        Parameters:
        condition - The condition to verify.
        message - The message to include in the exception thrown if the provided object is null.
        Throws:
        LDAPSDKUsageException - If the provided condition is true.
      • violation

        public static void violation​(java.lang.String message)
                              throws LDAPSDKUsageException
        Indicates that an expected condition was not true by throwing an LDAPSDKUsageException with the provided information.
        Parameters:
        message - The message to use for the resulting exception. It must not be null.
        Throws:
        LDAPSDKUsageException - To indicate that a violation occurred.
      • violation

        public static void violation​(java.lang.String message,
                                     java.lang.Throwable cause)
                              throws LDAPSDKUsageException
        Indicates that an expected condition was not true by throwing an LDAPSDKUsageException with the provided information.
        Parameters:
        message - The message to use for the resulting exception. It must not be null.
        cause - The exception that triggered the violation. It may be null if there is no associated exception.
        Throws:
        LDAPSDKUsageException - To indicate that a violation occurred.