ch.trick17.betterchecks.fluent

Class PrimitiveBaseCheck<C extends PrimitiveBaseCheck<C>>

java.lang.Object

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

ch.trick17.betterchecks.fluent.PrimitiveBaseCheck<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:

DoubleCheck, IntCheck, LongCheck

@GwtCompatible
public class PrimitiveBaseCheck<C extends PrimitiveBaseCheck<C>>
extends BaseCheck<C>

The base class for all primitive value checks. It manages the state and provides implementations common to these checks. The state consists of the disabled flag plus the state managed by BaseCheck.

Author:

Michael Faes

See Also:

ObjectBaseCheck

Field Summary

Fields inherited from class ch.trick17.betterchecks.fluent.BaseCheck

argName, inverted

Constructor Summary

Constructors

Constructor and Description
PrimitiveBaseCheck()

Method Summary

Modifier and Type	Method and Description
protected C	check(boolean condition, MessageType msgType, Object... msgArgs) A helper method that allows subclasses to perform simple checks conveniently with a one-liner.
protected C	disable() Disables all checks that are called on this check object.

Methods inherited from class ch.trick17.betterchecks.fluent.BaseCheck

checkConversion, me, named, not

Methods inherited from class java.lang.Object

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

Constructor Detail

PrimitiveBaseCheck

public PrimitiveBaseCheck()

Method Detail

disable

protected final C disable()

Disables all checks that are called on this check object. This is used for property checks where the owner is null and allowed to be null.

Returns:

This check

See Also:

ObjectBaseCheck.intPropertyCheck(int, String)

check

protected final C check(boolean condition,
                        MessageType msgType,
                        Object... msgArgs)

A helper method that allows subclasses to perform simple checks conveniently with a one-liner. It checks the given condition in the context of this check object's current state. This means:

• If this check is not disabled, it checks if the given condition is true or false respectively, depending on the inverted flag. If the check fails, an IllegalArgumentException is thrown, with a message formatted using the format belonging to the given message type and the given message arguments.
• Else (if this check is disabled), nothing happens.
• Then, it resets the inverted flag.
• Finally, it returns this check.

Parameters:

condition - The check condition

msgType - The message type to be used for the exception message thrown if the check fails

msgArgs - The arguments for the exception message

Returns:

This check