Static Public Member Functions
static void	argumentIsNotNull (Object argument)

static void	argumentsAreNotNull (Object...arguments)

static void	argumentIsPositive (int argument)

static void	argumentsArePositive (int...arguments)

static void	argumentIsNonNegative (int argument)

static void	argumentsAreNonNegative (int...arguments)

static void	argumentInsideBound (int argument, int max)

static void	argumentsInsideBounds (int x, int y, int width, int height)

static void	verifyState (boolean condition)

static void	validateArgument (boolean condition)

static< T > T	returnNonNull (T value)

Detailed Description

A collection of methods meant to help check method preconditions and postconditions.

Member Function Documentation

static void jade.util.Guard.argumentInsideBound	(	int	argument,
		int	max
	)

static

Throws an

IndexOutOfBoundsException

if the supplied bound is not between 0 (inclusive) and max (exclusive).

Parameters

argument	the argument being tested
max	the upper bound (exclusive) of the argument

static void jade.util.Guard.argumentIsNonNegative ( int argument )

static

Throws an

IllegalArgumentException

if the supplied argument is negative integer. In other words, the argument must be in the set {0, 1, 2,3, ...}, or the set of all positive integers.

Parameters

argument the argument being tested

static void jade.util.Guard.argumentIsNotNull ( Object argument )

static

Throws an

IllegalArgumentException

if the supplied argument is null.

Parameters

argument the argument being tested

static void jade.util.Guard.argumentIsPositive ( int argument )

static

Throws an

IllegalArgumentException

if the supplied argument is not a positive integer. In other words, the argument must be in the set {1, 2,3, ...}, or the set of all natural numbers.

Parameters

argument the argument being tested

static void jade.util.Guard.argumentsAreNonNegative ( int... arguments )

static

Throws an

IllegalArgumentException

if any of the supplied arguments are a negative integer. In other words, each argument must be in the set {0, 1, 2,3, ...}, or the set of all positive integer.

Parameters

arguments the arguments being tested

static void jade.util.Guard.argumentsAreNotNull ( Object... arguments )

static

Throws an

IllegalArgumentException

if any of the supplied arguments is null.

Parameters

arguments the arguments being tested

static void jade.util.Guard.argumentsArePositive ( int... arguments )

static

Throws an

IllegalArgumentException

if any of the supplied arguments are not a positive integer. In other words, each argument must be in the set {1, 2,3, ...}, or the set of all natural numbers.

Parameters

arguments the arguments being tested

static void jade.util.Guard.argumentsInsideBounds	(	int	x,
		int	y,
		int	width,
		int	height
	)

static

Throws an

IndexOutOfBoundsException

if the supplied (x, y) coordinate is not between inside the given bounds. In other words, x and y must be non-negative integers, with x less than width, and y less than height.

Parameters

x	the x location being tested
y	the y location being tested
width	the upper bound (exclusive) of x
height	the upper bound (exclusive) of y.

static <T> T jade.util.Guard.returnNonNull ( T value )

static

Returns the given return value if it is not null. Otherwise, an

IllegalStateException

is thrown. The typical usage would be as the return statement in another method (eg

return Guard.returnNonNull(value);

).

Parameters

<T>	the type of the value being tested for non-null
value	the value being returned and tested for non-null

Returns: value, if value is not null

static void jade.util.Guard.validateArgument ( boolean condition )

static

Throws an

IllegalArgumentException

if the given condition is not true.

Parameters

condition the state being tested

static void jade.util.Guard.verifyState ( boolean condition )

static

Throws an

IllegalStateException

if the given condition is not true.

Parameters

condition the state being tested

The documentation for this class was generated from the following file:

jade/util/Guard.java

Static Public Member Functions

Detailed Description

Member Function Documentation