Package org.openqa.selenium.internal

Class Require

java.lang.Object

org.openqa.selenium.internal.Require

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, File file)	Deprecated, for removal: This API element is subject to removal in a future version.
static Require.IntChecker	argument(String argName, Integer number)
static Require.PathChecker	argument(String argName, Path path)
static <T> Require.ArgumentChecker<T>	argument(String argName, T arg)
static int	nonNegative(String argName, Integer number)
static Duration	nonNegative(String argName, Duration arg)
static Duration	nonNegative(Duration arg)
static <T> T	nonNull(String argName, T arg)
static <T> T	nonNull(String argName, T arg, String message, Object... args)
static double	positive(String argName, Double number)
static double	positive(String argName, Double number, String message)
static int	positive(String argName, Integer number)
static int	positive(String argName, Integer number, String message)
static Duration	positive(String argName, Duration arg)
static Duration	positive(Duration arg)
static void	precondition(boolean condition, String message, Object... args)
static Require.FileStateChecker	state(String name, File file)	Deprecated, for removal: This API element is subject to removal in a future version.
static Require.PathStateChecker	state(String name, Path path)
static <T> Require.StateChecker<T>	state(String name, 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,
 T arg)

nonNull

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

argument

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

nonNegative

public static Duration nonNegative(String argName,
 Duration arg)

nonNegative

public static Duration nonNegative(Duration arg)

positive

public static Duration positive(String argName,
 Duration arg)

positive

public static Duration positive(Duration arg)

nonNegative

public static int nonNegative(String argName,
 Integer number)

positive

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

positive

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

positive

public static double positive(String argName,
 Double number)

positive

public static int positive(String argName,
 Integer number)

argument

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

argument

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

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

argument

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

stateCondition

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

state

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

state

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

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

state

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