com.google.gwt.core.shared.impl

Class InternalPreconditions

java.lang.Object

com.google.gwt.core.shared.impl.InternalPreconditions

public class InternalPreconditions
extends Object

A utility class that provides utility functions to do precondition checks inside GWT-SDK.

Constructor Summary

Constructors

Constructor and Description
InternalPreconditions()

Method Summary

Methods

Modifier and Type	Method and Description
static void	checkArgument(boolean expression) Ensures the truth of an expression involving one or more parameters to the calling method.
static void	checkArgument(boolean expression, Object errorMessage) Ensures the truth of an expression involving one or more parameters to the calling method.
static void	checkArgument(boolean expression, String errorMessageTemplate, Object... errorMessageArgs) Ensures the truth of an expression involving one or more parameters to the calling method.
static void	checkArraySize(int size) Ensures that size specifies a valid array size (i.e.
static void	checkArrayType(boolean expression, Object errorMessage) Ensures the truth of an expression that verifies array type.
static void	checkCriticalArgument(boolean expression) Ensures the truth of an expression involving one or more parameters to the calling method.
static void	checkCriticalArgument(boolean expression, Object errorMessage) Ensures the truth of an expression involving one or more parameters to the calling method.
static void	checkCriticalArgument(boolean expression, String errorMessageTemplate, Object... errorMessageArgs) Ensures the truth of an expression involving one or more parameters to the calling method.
static void	checkCriticalElement(boolean expression) Ensures the truth of an expression involving existence of an element.
static void	checkCriticalPositionIndexes(int start, int end, int size) Ensures that start and end specify a valid positions in an array, list or string of size size, and are in order.
static void	checkElement(boolean expression) Ensures the truth of an expression involving existence of an element.
static void	checkElement(boolean expression, Object errorMessage) Ensures the truth of an expression involving existence of an element.
static void	checkElementIndex(int index, int size) Ensures that index specifies a valid element in an array, list or string of size size.
static void	checkNotNull(Object reference, Object errorMessage) Ensures that an object reference passed as a parameter to the calling method is not null.
static <T> T	checkNotNull(T reference) Ensures that an object reference passed as a parameter to the calling method is not null.
static void	checkPositionIndex(int index, int size) Ensures that index specifies a valid position in an array, list or string of size size.
static void	checkPositionIndexes(int start, int end, int size) Ensures that start and end specify a valid positions in an array, list or string of size size, and are in order.
static void	checkState(boolean expression) Ensures the truth of an expression involving the state of the calling instance, but not involving any parameters to the calling method.
static void	checkState(boolean expression, Object errorMessage) Ensures the truth of an expression involving the state of the calling instance, but not involving any parameters to the calling method.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, toString

Constructor Detail

InternalPreconditions

public InternalPreconditions()

Method Detail

checkArrayType

public static void checkArrayType(boolean expression,
                  Object errorMessage)

Ensures the truth of an expression that verifies array type.

checkElement

public static void checkElement(boolean expression)

Ensures the truth of an expression involving existence of an element.

checkElement

public static void checkElement(boolean expression,
                Object errorMessage)

Ensures the truth of an expression involving existence of an element.

checkCriticalElement

public static void checkCriticalElement(boolean expression)

Ensures the truth of an expression involving existence of an element.

For cases where failing fast is pretty important and not failing early could cause bugs that are much harder to debug.

checkArgument

public static void checkArgument(boolean expression)

Ensures the truth of an expression involving one or more parameters to the calling method.

checkArgument

public static void checkArgument(boolean expression,
                 Object errorMessage)

Ensures the truth of an expression involving one or more parameters to the calling method.

checkArgument

public static void checkArgument(boolean expression,
                 String errorMessageTemplate,
                 Object... errorMessageArgs)

Ensures the truth of an expression involving one or more parameters to the calling method.

checkCriticalArgument

public static void checkCriticalArgument(boolean expression)

Ensures the truth of an expression involving one or more parameters to the calling method.

For cases where failing fast is pretty important and not failing early could cause bugs that are much harder to debug.

checkCriticalArgument

public static void checkCriticalArgument(boolean expression,
                         Object errorMessage)

Ensures the truth of an expression involving one or more parameters to the calling method.

For cases where failing fast is pretty important and not failing early could cause bugs that are much harder to debug.

checkCriticalArgument

public static void checkCriticalArgument(boolean expression,
                         String errorMessageTemplate,
                         Object... errorMessageArgs)

Ensures the truth of an expression involving one or more parameters to the calling method.

For cases where failing fast is pretty important and not failing early could cause bugs that are much harder to debug.

checkState

public static void checkState(boolean expression)

Ensures the truth of an expression involving the state of the calling instance, but not involving any parameters to the calling method.

Parameters:

expression - a boolean expression

Throws:

IllegalStateException - if expression is false

checkState

public static void checkState(boolean expression,
              Object errorMessage)

Ensures the truth of an expression involving the state of the calling instance, but not involving any parameters to the calling method.

checkNotNull

public static <T> T checkNotNull(T reference)

Ensures that an object reference passed as a parameter to the calling method is not null.

checkNotNull

public static void checkNotNull(Object reference,
                Object errorMessage)

Ensures that an object reference passed as a parameter to the calling method is not null.

checkArraySize

public static void checkArraySize(int size)

Ensures that size specifies a valid array size (i.e. non-negative).

checkElementIndex

public static void checkElementIndex(int index,
                     int size)

Ensures that index specifies a valid element in an array, list or string of size size. An element index may range from zero, inclusive, to size, exclusive.

checkPositionIndex

public static void checkPositionIndex(int index,
                      int size)

Ensures that index specifies a valid position in an array, list or string of size size. A position index may range from zero to size, inclusive.

checkPositionIndexes

public static void checkPositionIndexes(int start,
                        int end,
                        int size)

Ensures that start and end specify a valid positions in an array, list or string of size size, and are in order. A position index may range from zero to size, inclusive.

checkCriticalPositionIndexes

public static void checkCriticalPositionIndexes(int start,
                                int end,
                                int size)

Ensures that start and end specify a valid positions in an array, list or string of size size, and are in order. A position index may range from zero to size, inclusive.