ch.trick17.betterchecks.fluent

Class DoubleCheck

java.lang.Object

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

ch.trick17.betterchecks.fluent.PrimitiveBaseCheck<DoubleCheck>

ch.trick17.betterchecks.fluent.DoubleCheck

@GwtCompatible
public final class DoubleCheck
extends PrimitiveBaseCheck<DoubleCheck>

The check class for double arguments. It can also be (and is - if you use the Check methods correctly) used for float arguments.

It provides methods like isPositive() or isBetween(double, double) but also methods specific to floating numbers like isNotInfinite() and isNotNaN().

Author:

Michael Faes

Field Summary

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

argName, inverted

Constructor Summary

Constructors

Constructor and Description
DoubleCheck(double arg) For internal use only.

Method Summary

Modifier and Type	Method and Description
DoubleCheck	is(double number) Checks that the double argument is equal to the given number, throwing an exception otherwise.
DoubleCheck	isBetween(double min, double max) Checks that the double argument is greater than or equal to min and less than or equal to max, throwing an exception otherwise.
DoubleCheck	isGreaterThan(double number) Checks that the double argument is (strictly) greater than the given number, throwing an exception otherwise.
DoubleCheck	isLessThan(double number) Checks that the double argument is (strictly) less than the given number, throwing an exception otherwise.
DoubleCheck	isNegative() Checks that the double argument is negative, throwing an exception otherwise.
DoubleCheck	isNotInfinite() Checks that the double argument is not infinite (positive or negative), throwing an exception otherwise.
DoubleCheck	isNotNaN() Checks that the double argument is not NaN (not a number, see Double.NaN), throwing an exception otherwise.
DoubleCheck	isPositive() Checks that the double argument is positive, throwing an exception otherwise.

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

check, disable

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

DoubleCheck

public DoubleCheck(double arg)

For internal use only.

Method Detail

isPositive

public DoubleCheck isPositive()

Checks that the double argument is positive, throwing an exception otherwise. Note that zero is not a valid number. Often, you want to check that a number is non-negative. Use the inverted isNegative() check for that:

Check.that(number).not().isNegative();

The message type used for exceptions thrown by this method is MessageType.ARG_POSITIVE.

Returns:

This check

Throws:

IllegalArgumentException - if argument is not positive

See Also:

isNegative()

isNegative

public DoubleCheck isNegative()

Checks that the double argument is negative, throwing an exception otherwise.

The message type used for exceptions thrown by this method is MessageType.ARG_NEGATIVE.

Returns:

This check

Throws:

IllegalArgumentException - if argument is not negative

See Also:

isPositive()

is

public DoubleCheck is(double number)

Checks that the double argument is equal to the given number, throwing an exception otherwise. This check exists merely for reasons of symmetry to the IntCheck class which can be used as a property check. See StringCheck.hasLengthWhich() for example. However, in conjunction with inversion (see BaseCheck.not()), this method can also be used to exclude a single value.

The message type used for exceptions thrown by this method is MessageType.ARG_IS.

Parameters:

number - The number this argument must be equal to

Returns:

This check

Throws:

IllegalArgumentException - if argument is not equal to the given number

isGreaterThan

public DoubleCheck isGreaterThan(double number)

Checks that the double argument is (strictly) greater than the given number, throwing an exception otherwise. To create a greater-than-or-equals check, you may use an inverted isLessThan(double) check:

Check.that(number).not().isLessThan(1.0);

The message type used for exceptions thrown by this method is MessageType.ARG_GREATER.

Parameters:

number - The number this argument must be greater than

Returns:

This check

Throws:

IllegalArgumentException - if argument is not greater than the given number

isLessThan

public DoubleCheck isLessThan(double number)

Checks that the double argument is (strictly) less than the given number, throwing an exception otherwise. To create a less-than-or-equals check, you may use an inverted isGreaterThan(double) check:

Check.that(number).not().isGreaterThan(1.0);

The message type used for exceptions thrown by this method is MessageType.ARG_LESS.

Parameters:

number - The number this argument must be less than

Returns:

This check

Throws:

IllegalArgumentException - if argument is not less than the given number

isBetween

public DoubleCheck isBetween(double min,
                             double max)

Checks that the double argument is greater than or equal to min and less than or equal to max, throwing an exception otherwise.

To create a strict or one-sided-strict between test, you may use the isGreaterThan(double) and isLessThan(double) checks, possibly in conjunction with BaseCheck.not().

The message type used for exceptions thrown by this method is MessageType.ARG_BETWEEN.

Parameters:

min - The minimum number

max - The maximum number

Returns:

This check

Throws:

IllegalArgumentException - if argument is not between the two given numbers as defined above

isNotNaN

public DoubleCheck isNotNaN()

Checks that the double argument is not NaN (not a number, see Double.NaN), throwing an exception otherwise.

The message type used for exceptions thrown by this method is MessageType.ARG_NAN.

Returns:

This check

Throws:

IllegalArgumentException - if argument is NaN

isNotInfinite

public DoubleCheck isNotInfinite()

Checks that the double argument is not infinite (positive or negative), throwing an exception otherwise.

The message type used for exceptions thrown by this method is MessageType.ARG_INFINITE.

Returns:

This check

Throws:

IllegalArgumentException - if argument is infinite