ch.trick17.betterchecks.fluent

Class BaseCheck<C extends BaseCheck<C>>

java.lang.Object

ch.trick17.betterchecks.fluent.BaseCheck<C>

Type Parameters:

C - The type of the concrete check class. This parameter is necessary for this base class to define methods that return the check object itself (with the correct static type), which is necessary for the fluent interface of all checks.

Direct Known Subclasses:

ObjectBaseCheck, PrimitiveBaseCheck

@GwtCompatible
public abstract class BaseCheck<C extends BaseCheck<C>>
extends Object

The base class for all checks. It manages the state common to all checks: the argument name and the inverted flag. This class has two abstract subclasses which all concrete checks inherit from: ObjectBaseCheck and PrimitiveBaseCheck.

Author:

Michael Faes

Field Summary

Fields

Modifier and Type	Field and Description
protected String	argName The argument name.
protected boolean	inverted The inverted flag.

Constructor Summary

Constructors

Constructor and Description
BaseCheck()

Method Summary

Modifier and Type	Method and Description
protected void	checkConversion() Asserts that the check is not inverted, throwing an InvalidCheckException otherwise.
protected C	me() Simply casts this check to the C type parameter (which should always be equal to the class of the concrete check).
C	named(String argumentName) Gives the argument to be checked a name.
C	not() Inverts the following check.

Methods inherited from class java.lang.Object

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

Field Detail

argName

protected String argName

The argument name. It is initialized as Exceptions.defaultArgName() and can be changed using the named(String) modifier method.

inverted

protected boolean inverted

The inverted flag. If it is true, the condition of the next check must be inverted. It is initialized as false and can be set with the not() modifier method.

Note that each check must reset this flag to false.

Constructor Detail

BaseCheck

public BaseCheck()

Method Detail

named

public final C named(String argumentName)

Gives the argument to be checked a name. This name is used to provide more meaningful exception messages in case a check fails. This modifier should be called before any of the checks. Otherwise, the default argument name (given by Exceptions.defaultArgName()) is used.

Parameters:

argumentName - The name of the argument to be checked

Returns:

This check

not

public final C not()

Inverts the following check. For example, if the next check would require that a string is not empty, inverting it would require that the string is empty.

Note that the check inversion only affects the explicit check and not the implicit null check that is done by each check method of ObjectBaseCheck subclasses. The explicit isNotNull() check can also be inverted this way.

Returns:

This check

checkConversion

protected final void checkConversion()

Asserts that the check is not inverted, throwing an InvalidCheckException otherwise. This should be done before each conversion, e.g., with StringCheck.isIntWhich().

me

protected final C me()

Simply casts this check to the C type parameter (which should always be equal to the class of the concrete check).

Returns:

This check as C