Package org.openqa.selenium.internal

Class Require

java.lang.Object

org.openqa.selenium.internal.Require

@NullMarked
public final class Require
extends Object

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);
   }
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Require.ArgumentChecker<T>
static class	Require.FileChecker	Deprecated, for removal: This API element is subject to removal in a future version.
static class	Require.FileStateChecker	Deprecated, for removal: This API element is subject to removal in a future version.
static class	Require.IntChecker
static class	Require.PathChecker
static class	Require.PathStateChecker
static class	Require.StateChecker<T>

Method Summary

Modifier and Type	Method	Description
static Require.FileChecker	argument(String argName, @Nullable File file)	Deprecated, for removal: This API element is subject to removal in a future version.
static Require.IntChecker	argument(String argName, @Nullable Integer number)
static Require.PathChecker	argument(String argName, @Nullable Path path)
static <T> Require.ArgumentChecker<T>	argument(String argName, @Nullable T arg)
static Duration	nonNegative(@Nullable Duration arg)
static int	nonNegative(String argName, @Nullable Integer number)
static Duration	nonNegative(String argName, @Nullable Duration arg)
static <T> T	nonNull(String argName, @Nullable T arg)
static <T> T	nonNull(String argName, @Nullable T arg, String message, Object... args)
static Duration	positive(@Nullable Duration arg)
static double	positive(String argName, @Nullable Double number)
static double	positive(String argName, @Nullable Double number, @Nullable String message)
static int	positive(String argName, @Nullable Integer number)
static int	positive(String argName, @Nullable Integer number, @Nullable String message)
static Duration	positive(String argName, @Nullable Duration arg)
static void	precondition(boolean condition, String message, Object... args)
static Require.FileStateChecker	state(String name, @Nullable File file)	Deprecated, for removal: This API element is subject to removal in a future version.
static Require.PathStateChecker	state(String name, @Nullable Path path)
static <T> Require.StateChecker<T>	state(String name, @Nullable T state)
static void	stateCondition(boolean state, String message, Object... args)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

precondition

public static void precondition(boolean condition,
 String message,
 Object... args)

nonNull

public static <T> T nonNull(String argName,
 @Nullable T arg)

nonNull

public static <T> T nonNull(String argName,
 @Nullable T arg,
 String message,
 Object... args)

argument

public static <T> Require.ArgumentChecker<T> argument(String argName,
 @Nullable T arg)

nonNegative

public static Duration nonNegative(String argName,
 @Nullable Duration arg)

nonNegative

public static Duration nonNegative(@Nullable Duration arg)

positive

public static Duration positive(String argName,
 @Nullable Duration arg)

positive

public static Duration positive(@Nullable Duration arg)

nonNegative

public static int nonNegative(String argName,
 @Nullable Integer number)

positive

public static int positive(String argName,
 @Nullable Integer number,
 @Nullable String message)

positive

public static double positive(String argName,
 @Nullable Double number,
 @Nullable String message)

positive

public static double positive(String argName,
 @Nullable Double number)

positive

public static int positive(String argName,
 @Nullable Integer number)

argument

public static Require.IntChecker argument(String argName,
 @Nullable Integer number)

argument

@Deprecated(forRemoval=true)
public static Require.FileChecker argument(String argName,
 @Nullable File file)

Deprecated, for removal: This API element is subject to removal in a future version.

argument

public static Require.PathChecker argument(String argName,
 @Nullable Path path)

stateCondition

public static void stateCondition(boolean state,
 String message,
 Object... args)

state

public static <T> Require.StateChecker<T> state(String name,
 @Nullable T state)

state

@Deprecated(forRemoval=true)
public static Require.FileStateChecker state(String name,
 @Nullable File file)

Deprecated, for removal: This API element is subject to removal in a future version.

state

public static Require.PathStateChecker state(String name,
 @Nullable Path path)