edu.mit.jverbnet.util
Interface Checks.ICheck<S>

Type Parameters:

S - the superclass of the objects dealt with by this check

All Superinterfaces:

Checks.ICondition<S>

All Known Implementing Classes:

Checks.Check, Checks.Mask

Enclosing class:

Checks

public static interface Checks.ICheck<S>
extends Checks.ICondition<S>

A check object provides the ability to throw an exception when a specified object satisfies the condition.

Since:

JVerbnet 1.0.0

Version:

1.0.0

Author:

Mark A. Finlayson

Method Summary

<T extends S> T

check(java.lang.String varName, T value) Throws an exception if the specified object does not satisfy the condition.

Methods inherited from interface edu.mit.jverbnet.util.Checks.ICondition

allowsNulls, is

Method Detail

check

<T extends S> T check(java.lang.String varName,
                      T value)

Throws an exception if the specified object does not satisfy the condition.

Parameters:

varName - the variable name to be used in the exception message; if the name is null, empty, or all whitespace, the generic variable name is used.

value - the value to check

Returns:

the object specified; some checks return a modified version of the object (e.g., a trimmed string)

Throws:

java.lang.NullPointerException - if the specified value is null, and nulls are not allowed

java.lang.IllegalArgumentException - if the specified value is does not meet the condition

Since:

JVerbnet 1.0.0