Package com.unboundid.util
Class Validator
- java.lang.Object
-
- com.unboundid.util.Validator
-
@ThreadSafety(level=COMPLETELY_THREADSAFE) public final class Validator extends java.lang.Object
This class provides a number of methods that can be used to enforce constraints on the behavior of SDK methods.
-
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static voidensureFalse(boolean condition)Ensures that the provided condition isfalse.static voidensureFalse(boolean condition, java.lang.String message)Ensures that the provided condition isfalse.static voidensureNotNull(java.lang.Object o)Ensures that the provided object is notnull.static voidensureNotNull(java.lang.Object o1, java.lang.Object o2)Ensures that none of the provided objects isnull.static voidensureNotNull(java.lang.Object o1, java.lang.Object o2, java.lang.Object o3)Ensures that none of the provided objects isnull.static voidensureNotNull(java.lang.Object o1, java.lang.Object o2, java.lang.Object o3, java.lang.Object o4)Ensures that none of the provided objects isnull.static voidensureNotNull(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 isnull.static voidensureNotNullOrEmpty(byte[] array)Ensures that the provided array is notnulland has a length of at least one.static voidensureNotNullOrEmpty(byte[] array, java.lang.String message)Ensures that the provided array is notnulland has a length of at least one.static voidensureNotNullOrEmpty(char[] array)Ensures that the provided array is notnulland has a length of at least one.static voidensureNotNullOrEmpty(char[] array, java.lang.String message)Ensures that the provided array is notnulland has a length of at least one.static voidensureNotNullOrEmpty(int[] array)Ensures that the provided array is notnulland has a length of at least one.static voidensureNotNullOrEmpty(int[] array, java.lang.String message)Ensures that the provided array is notnulland has a length of at least one.static voidensureNotNullOrEmpty(long[] array)Ensures that the provided array is notnulland has a length of at least one.static voidensureNotNullOrEmpty(long[] array, java.lang.String message)Ensures that the provided array is notnulland has a length of at least one.static voidensureNotNullOrEmpty(java.lang.CharSequence charSequence)Ensures that the provided character sequence is notnulland has a length of at least one.static voidensureNotNullOrEmpty(java.lang.CharSequence charSequence, java.lang.String message)Ensures that the provided character sequence is notnulland has a length of at least one.static voidensureNotNullOrEmpty(java.lang.Object[] array)Ensures that the provided array is notnulland has a length of at least one.static voidensureNotNullOrEmpty(java.lang.Object[] array, java.lang.String message)Ensures that the provided array is notnulland has a length of at least one.static voidensureNotNullOrEmpty(java.util.Collection<?> collection)Ensures that the provided collection is notnulland contains at least one item.static voidensureNotNullOrEmpty(java.util.Collection<?> collection, java.lang.String message)Ensures that the provided collection is notnulland contains at least one item.static voidensureNotNullOrEmpty(java.util.Map<?,?> map)Ensures that the provided map is notnulland contains at least one item.static voidensureNotNullOrEmpty(java.util.Map<?,?> map, java.lang.String message)Ensures that the provided map is notnulland contains at least one item.static voidensureNotNullWithMessage(java.lang.Object o, java.lang.String message)Ensures that the provided object is notnull.static voidensureTrue(boolean condition)Ensures that the provided condition istrue.static voidensureTrue(boolean condition, java.lang.String message)Ensures that the provided condition istrue.static voidviolation(java.lang.String message)Indicates that an expected condition was not true by throwing anLDAPSDKUsageExceptionwith the provided information.static voidviolation(java.lang.String message, java.lang.Throwable cause)Indicates that an expected condition was not true by throwing anLDAPSDKUsageExceptionwith the provided information.
-
-
-
Method Detail
-
ensureNotNull
public static void ensureNotNull(@Nullable java.lang.Object o) throws LDAPSDKUsageException
Ensures that the provided object is notnull.- Parameters:
o- The object to examine.- Throws:
LDAPSDKUsageException- If the provided object isnull.
-
ensureNotNullWithMessage
public static void ensureNotNullWithMessage(@Nullable java.lang.Object o, @NotNull java.lang.String message) throws LDAPSDKUsageException
Ensures that the provided object is notnull.- Parameters:
o- The object to examine.message- The message to include in the exception thrown if the provided object isnull.- Throws:
LDAPSDKUsageException- If the provided object isnull.
-
ensureNotNull
public static void ensureNotNull(@Nullable java.lang.Object o1, @Nullable java.lang.Object o2) throws LDAPSDKUsageException
Ensures that none of the provided objects isnull.- 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 isnull.
-
ensureNotNull
public static void ensureNotNull(@Nullable java.lang.Object o1, @Nullable java.lang.Object o2, @Nullable java.lang.Object o3) throws LDAPSDKUsageException
Ensures that none of the provided objects isnull.- 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 isnull.
-
ensureNotNull
public static void ensureNotNull(@Nullable java.lang.Object o1, @Nullable java.lang.Object o2, @Nullable java.lang.Object o3, @Nullable java.lang.Object o4) throws LDAPSDKUsageException
Ensures that none of the provided objects isnull.- 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 isnull.
-
ensureNotNull
public static void ensureNotNull(@Nullable java.lang.Object o1, @Nullable java.lang.Object o2, @Nullable java.lang.Object o3, @Nullable java.lang.Object o4, @Nullable java.lang.Object o5) throws LDAPSDKUsageException
Ensures that none of the provided objects isnull.- 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 isnull.
-
ensureNotNullOrEmpty
public static void ensureNotNullOrEmpty(@Nullable java.util.Collection<?> collection)
Ensures that the provided collection is notnulland contains at least one item.- Parameters:
collection- The collection to verify.- Throws:
LDAPSDKUsageException- If the provided collection isnullor empty.
-
ensureNotNullOrEmpty
public static void ensureNotNullOrEmpty(@Nullable java.util.Collection<?> collection, @NotNull java.lang.String message)
Ensures that the provided collection is notnulland contains at least one item.- Parameters:
collection- The collection to verify.message- The message to include in the exception thrown if the provided collection isnullor empty.- Throws:
LDAPSDKUsageException- If the provided collection isnullor empty.
-
ensureNotNullOrEmpty
public static void ensureNotNullOrEmpty(@Nullable java.util.Map<?,?> map)
Ensures that the provided map is notnulland contains at least one item.- Parameters:
map- The map to verify.- Throws:
LDAPSDKUsageException- If the provided map isnullor empty.
-
ensureNotNullOrEmpty
public static void ensureNotNullOrEmpty(@Nullable java.util.Map<?,?> map, @NotNull java.lang.String message)
Ensures that the provided map is notnulland contains at least one item.- Parameters:
map- The map to verify.message- The message to include in the exception thrown if the provided map isnullor empty.- Throws:
LDAPSDKUsageException- If the provided map isnullor empty.
-
ensureNotNullOrEmpty
public static void ensureNotNullOrEmpty(@Nullable java.lang.Object[] array)
Ensures that the provided array is notnulland has a length of at least one.- Parameters:
array- The array to verify.- Throws:
LDAPSDKUsageException- If the provided array isnullor empty.
-
ensureNotNullOrEmpty
public static void ensureNotNullOrEmpty(@Nullable java.lang.Object[] array, @NotNull java.lang.String message)
Ensures that the provided array is notnulland 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 isnullor empty.- Throws:
LDAPSDKUsageException- If the provided array isnullor empty.
-
ensureNotNullOrEmpty
public static void ensureNotNullOrEmpty(@Nullable byte[] array)
Ensures that the provided array is notnulland has a length of at least one.- Parameters:
array- The array to verify.- Throws:
LDAPSDKUsageException- If the provided array isnullor empty.
-
ensureNotNullOrEmpty
public static void ensureNotNullOrEmpty(@Nullable byte[] array, @NotNull java.lang.String message)
Ensures that the provided array is notnulland 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 isnullor empty.- Throws:
LDAPSDKUsageException- If the provided array isnullor empty.
-
ensureNotNullOrEmpty
public static void ensureNotNullOrEmpty(@Nullable char[] array)
Ensures that the provided array is notnulland has a length of at least one.- Parameters:
array- The array to verify.- Throws:
LDAPSDKUsageException- If the provided array isnullor empty.
-
ensureNotNullOrEmpty
public static void ensureNotNullOrEmpty(@Nullable char[] array, @NotNull java.lang.String message)
Ensures that the provided array is notnulland 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 isnullor empty.- Throws:
LDAPSDKUsageException- If the provided array isnullor empty.
-
ensureNotNullOrEmpty
public static void ensureNotNullOrEmpty(@Nullable int[] array)
Ensures that the provided array is notnulland has a length of at least one.- Parameters:
array- The array to verify.- Throws:
LDAPSDKUsageException- If the provided array isnullor empty.
-
ensureNotNullOrEmpty
public static void ensureNotNullOrEmpty(@Nullable int[] array, @NotNull java.lang.String message)
Ensures that the provided array is notnulland 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 isnullor empty.- Throws:
LDAPSDKUsageException- If the provided array isnullor empty.
-
ensureNotNullOrEmpty
public static void ensureNotNullOrEmpty(@Nullable long[] array)
Ensures that the provided array is notnulland has a length of at least one.- Parameters:
array- The array to verify.- Throws:
LDAPSDKUsageException- If the provided array isnullor empty.
-
ensureNotNullOrEmpty
public static void ensureNotNullOrEmpty(@Nullable long[] array, @NotNull java.lang.String message)
Ensures that the provided array is notnulland 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 isnullor empty.- Throws:
LDAPSDKUsageException- If the provided array isnullor empty.
-
ensureNotNullOrEmpty
public static void ensureNotNullOrEmpty(@Nullable java.lang.CharSequence charSequence)
Ensures that the provided character sequence is notnulland has a length of at least one.- Parameters:
charSequence- The character sequence to verify.- Throws:
LDAPSDKUsageException- If the provided character sequence isnullor empty.
-
ensureNotNullOrEmpty
public static void ensureNotNullOrEmpty(@Nullable java.lang.CharSequence charSequence, @NotNull java.lang.String message)
Ensures that the provided character sequence is notnulland 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 isnullor empty.- Throws:
LDAPSDKUsageException- If the provided character sequence isnullor empty.
-
ensureTrue
public static void ensureTrue(boolean condition) throws LDAPSDKUsageException
Ensures that the provided condition istrue.- Parameters:
condition- The condition to verify.- Throws:
LDAPSDKUsageException- If the provided condition isfalse.
-
ensureTrue
public static void ensureTrue(boolean condition, @NotNull java.lang.String message) throws LDAPSDKUsageException
Ensures that the provided condition istrue.- Parameters:
condition- The condition to verify.message- The message to include in the exception thrown if the provided object isnull.- Throws:
LDAPSDKUsageException- If the provided condition isfalse.
-
ensureFalse
public static void ensureFalse(boolean condition) throws LDAPSDKUsageException
Ensures that the provided condition isfalse.- Parameters:
condition- The condition to verify.- Throws:
LDAPSDKUsageException- If the provided condition istrue.
-
ensureFalse
public static void ensureFalse(boolean condition, @NotNull java.lang.String message) throws LDAPSDKUsageException
Ensures that the provided condition isfalse.- Parameters:
condition- The condition to verify.message- The message to include in the exception thrown if the provided object isnull.- Throws:
LDAPSDKUsageException- If the provided condition istrue.
-
violation
public static void violation(@NotNull java.lang.String message) throws LDAPSDKUsageException
Indicates that an expected condition was not true by throwing anLDAPSDKUsageExceptionwith the provided information.- Parameters:
message- The message to use for the resulting exception. It must not benull.- Throws:
LDAPSDKUsageException- To indicate that a violation occurred.
-
violation
public static void violation(@NotNull java.lang.String message, @Nullable java.lang.Throwable cause) throws LDAPSDKUsageException
Indicates that an expected condition was not true by throwing anLDAPSDKUsageExceptionwith the provided information.- Parameters:
message- The message to use for the resulting exception. It must not benull.cause- The exception that triggered the violation. It may benullif there is no associated exception.- Throws:
LDAPSDKUsageException- To indicate that a violation occurred.
-
-