Class Preconditions

java.lang.Object
com.ongres.scram.common.util.Preconditions

public final class Preconditions extends Object
Generic utility methods used to validate data.
  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    private
     
  • Method Summary

    Modifier and Type
    Method
    Description
    static <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
    gt0(int value, @NotNull String valueName)
    Checks that the integer argument is positive.
    static boolean
    isNullOrEmpty(@Nullable String string)
    Returns true if the given string is null or is the empty string.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Constructor Details

    • Preconditions

      private Preconditions()
  • Method Details

    • checkNotNull

      @NotNull public static <T> T checkNotNull(@Nullable T value, @NotNull @NotNull String valueName)
      Checks that the argument is not null.
      Type Parameters:
      T - The type of the value
      Parameters:
      value - The value to be checked
      valueName - 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 check
      valueName - 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 check
      valueName - 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

      public static void checkArgument(boolean check, @NotNull @NotNull String valueName)
      Checks that the argument is valid, based in a check boolean condition.
      Parameters:
      check - The boolean check
      valueName - 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 check
      valueName - The name of the value that is checked in the method
      errMsg - Detail of the error message
      Throws:
      IllegalArgumentException - if check is not valid
    • gt0

      public static int gt0(int value, @NotNull @NotNull String valueName)
      Checks that the integer argument is positive.
      Parameters:
      value - The value to be checked
      valueName - 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

      public static boolean isNullOrEmpty(@Nullable @Nullable String string)
      Returns true 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