Class Require

java/src/org/openqa/selenium/internal/Require.java:40–430

A utility class to check arguments (preconditions) and state. Examples of use: public void setActionWithTimeout(Action action delegate, int timeout) { this.action = Require.nonNull("Action", action); this.timeout = Require.positive("Timeout", timeout); }

 * </pre>
 */
@NullMarked
public final class Require {

  private static final String MUST_BE_SET = "%s must be set";
  private static final String MUST_NOT_BE_SET = "%s must not be set";
  private static final String MUST_EXIST = "%s must exist: %s";
  private static final String MUST_BE_DIR = "%s must be a directory: %s";
  private static final String MUST_BE_FILE = "%s must be a regular file: %s";
  private static final String MUST_BE_EQUAL = "%s must be equal to `%s`";
  private static final String MUST_BE_EXECUTABLE = "%s must be executable: %s";
  private static final String MUST_BE_NON_NEGATIVE = "%s must be 0 or greater";
  private static final String MUST_BE_POSITIVE = "%s must be greater than 0";
  private static final String MUST_BE_BETWEEN = "%s must be between %s and %s (inclusive)";
  private static final String MUST_NOT_BE_EMPTY = "%s must not be empty";
  private static final String MUST_NOT_BE_BLANK = "%s must not be blank";

  private Require() {
    // An utility class
  }

  public static void precondition(boolean condition, String message, Object... args) {
    if (!condition) {
      throw new IllegalArgumentException(String.format(message, args));
    }
  }

  public static <T> T nonNull(String argName, @Nullable T arg) {
    if (arg == null) {
      throw new IllegalArgumentException(String.format(MUST_BE_SET, argName));
    }
    return arg;
  }

  public static <T> T nonNull(String argName, @Nullable T arg, String message, Object... args) {
    if (arg == null) {
      throw new IllegalArgumentException(String.join(" ", argName, String.format(message, args)));
    }
    return arg;
  }

  public static <T> void isNull(String argName, @Nullable T arg) {
    if (arg != null) {
      throw new IllegalArgumentException(String.format(MUST_NOT_BE_SET, argName));
    }
  }

  public static <T> ArgumentChecker<T> argument(String argName, @Nullable T arg) {
    return new ArgumentChecker<>(argName, arg);
  }

  public static Duration nonNegative(String argName, @Nullable Duration arg) {
    nonNull(argName, arg);
    if (arg.isNegative()) {
      throw new IllegalArgumentException(String.format(MUST_BE_NON_NEGATIVE, argName));
    }
    return arg;
  }