Package com.ongres.scram.common.util
Class Preconditions
java.lang.Object
com.ongres.scram.common.util.Preconditions
Generic utility methods used to validate data.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic <T> T
castNonNull
(T ref) static void
checkArgument
(boolean check, @NotNull String valueName) Checks that the argument is valid, based in a check boolean condition.static void
checkArgument
(boolean check, @NotNull String valueName, @NotNull String errMsg) Checks that the argument is valid, based in a check boolean condition.static char @NotNull []
checkNotEmpty
(char @NotNull [] value, @NotNull String valueName) Checks that the char[] is not null and not empty.static @NotNull String
checkNotEmpty
(@NotNull String value, @NotNull String valueName) Checks that the String is not null and not empty.static <T> T
checkNotNull
(T value, @NotNull String valueName) Checks that the argument is not null.static int
Checks that the integer argument is positive.static boolean
isNullOrEmpty
(@Nullable String string) Returnstrue
if the given string is null or is the empty string.
-
Constructor Details
-
Preconditions
private Preconditions()
-
-
Method Details
-
checkNotNull
Checks that the argument is not null.- Type Parameters:
T
- The type of the value- Parameters:
value
- The value to be checkedvalueName
- The name of the value that is checked in the method- Returns:
- The same value passed as argument
- Throws:
IllegalArgumentException
- If value is null.
-
castNonNull
@NotNull public static <T> T castNonNull(@Nullable T ref) -
checkNotEmpty
@NotNull public static @NotNull String checkNotEmpty(@NotNull @NotNull String value, @NotNull @NotNull String valueName) Checks that the String is not null and not empty.- Parameters:
value
- The String to checkvalueName
- The name of the value that is checked in the method- Returns:
- The same String passed as argument
- Throws:
IllegalArgumentException
- If value is null or empty
-
checkNotEmpty
public static char @NotNull [] checkNotEmpty(char @NotNull [] value, @NotNull @NotNull String valueName) Checks that the char[] is not null and not empty.- Parameters:
value
- The String to checkvalueName
- The name of the value that is checked in the method- Returns:
- The same String passed as argument
- Throws:
IllegalArgumentException
- If value is null or empty
-
checkArgument
Checks that the argument is valid, based in a check boolean condition.- Parameters:
check
- The boolean checkvalueName
- The name of the value that is checked in the method- Throws:
IllegalArgumentException
- if check is not valid
-
checkArgument
public static void checkArgument(boolean check, @NotNull @NotNull String valueName, @NotNull @NotNull String errMsg) Checks that the argument is valid, based in a check boolean condition.- Parameters:
check
- The boolean checkvalueName
- The name of the value that is checked in the methoderrMsg
- Detail of the error message- Throws:
IllegalArgumentException
- if check is not valid
-
gt0
Checks that the integer argument is positive.- Parameters:
value
- The value to be checkedvalueName
- The name of the value that is checked in the method- Returns:
- The same value passed as argument
- Throws:
IllegalArgumentException
- If value is equal or less than 0
-
isNullOrEmpty
Returnstrue
if the given string is null or is the empty string.- Parameters:
string
- a String reference to check- Returns:
true
if the string is null or the string is empty
-