org.assertj.core.api

Class DoubleAssert

java.lang.Object

org.assertj.core.api.AbstractAssert<S,A>

org.assertj.core.api.AbstractComparableAssert<DoubleAssert,Double>

org.assertj.core.api.DoubleAssert

All Implemented Interfaces:

Assert<DoubleAssert,Double>, ComparableAssert<DoubleAssert,Double>, Descriptable<DoubleAssert>, ExtensionPoints<DoubleAssert,Double>, FloatingPointNumberAssert<Double>, NumberAssert<Double>

public class DoubleAssert
extends AbstractComparableAssert<DoubleAssert,Double>
implements FloatingPointNumberAssert<Double>

Assertion methods for doubles.

To create an instance of this class, invoke Assertions.assertThat(Double) or Assertions.assertThat(double).

Author:

Yvonne Wang, David DIDIER, Alex Ruiz, Ansgar Konermann, Joel Costigliola, Mikhail Mazursky, Nicolas François

Field Summary

Fields inherited from class org.assertj.core.api.AbstractAssert

actual, info, myself

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DoubleAssert(Double actual)

Method Summary

Methods

Modifier and Type	Method and Description
DoubleAssert	isEqualTo(double expected) Verifies that the actual value is equal to the given one.
DoubleAssert	isEqualTo(double expected, Offset<Double> offset) Verifies that the actual value is equal to the given one, within a positive offset.
DoubleAssert	isEqualTo(Double expected, Offset<Double> offset) Verifies that the actual value is equal to the given one, within a positive offset.
DoubleAssert	isGreaterThan(double other) Verifies that the actual value is greater than the given one.
DoubleAssert	isGreaterThanOrEqualTo(double other) Verifies that the actual value is greater than or equal to the given one.
DoubleAssert	isLessThan(double other) Verifies that the actual value is less than the given one.
DoubleAssert	isLessThanOrEqualTo(double other) Verifies that the actual value is less than or equal to the given one.
DoubleAssert	isNaN() Verifies that the actual value is equal to NaN.
DoubleAssert	isNegative() Verifies that the actual value is negative.
DoubleAssert	isNotEqualTo(double other) Verifies that the actual value is not equal to the given one.
DoubleAssert	isNotNaN() Verifies that the actual value is not equal to NaN.
DoubleAssert	isNotNegative() Verifies that the actual value is non negative (positive or equal zero).
DoubleAssert	isNotPositive() Verifies that the actual value is non positive (negative or equal zero).
DoubleAssert	isNotZero() Verifies that the actual value is not equal to zero.
DoubleAssert	isPositive() Verifies that the actual value is positive.
DoubleAssert	isZero() Verifies that the actual value is equal to zero.
DoubleAssert	usingComparator(Comparator<? super Double> customComparator) Use given custom comparator instead of relying on actual type A equals method for incoming assertion checks.
DoubleAssert	usingDefaultComparator() Revert to standard comparison for incoming assertion checks.

Methods inherited from class org.assertj.core.api.AbstractComparableAssert

isGreaterThan, isGreaterThanOrEqualTo, isLessThan, isLessThanOrEqualTo

Methods inherited from class org.assertj.core.api.AbstractAssert

as, as, describedAs, describedAs, descriptionText, doesNotHave, doesNotHaveSameClassAs, equals, failWithMessage, getWritableAssertionInfo, has, hashCode, hasSameClassAs, is, isEqualTo, isExactlyInstanceOf, isIn, isIn, isInstanceOf, isInstanceOfAny, isNot, isNotEqualTo, isNotExactlyInstanceOf, isNotIn, isNotIn, isNotInstanceOf, isNotInstanceOfAny, isNotNull, isNotOfAnyClassIn, isNotSameAs, isNull, isOfAnyClassIn, isSameAs, overridingErrorMessage

Methods inherited from class java.lang.Object

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

Constructor Detail

DoubleAssert

protected DoubleAssert(Double actual)

Method Detail

isNaN

public DoubleAssert isNaN()

Verifies that the actual value is equal to NaN.

Specified by:

isNaN in interface FloatingPointNumberAssert<Double>

Returns:

this assertion object.

isNotNaN

public DoubleAssert isNotNaN()

Verifies that the actual value is not equal to NaN.

Specified by:

isNotNaN in interface FloatingPointNumberAssert<Double>

Returns:

this assertion object.

isZero

public DoubleAssert isZero()

Verifies that the actual value is equal to zero.

Specified by:

isZero in interface NumberAssert<Double>

Returns:

this assertion object.

isNotZero

public DoubleAssert isNotZero()

Verifies that the actual value is not equal to zero.

Specified by:

isNotZero in interface NumberAssert<Double>

Returns:

this assertion object.

isPositive

public DoubleAssert isPositive()

Verifies that the actual value is positive.

Specified by:

isPositive in interface NumberAssert<Double>

Returns:

this assertion object.

isNegative

public DoubleAssert isNegative()

Verifies that the actual value is negative.

Specified by:

isNegative in interface NumberAssert<Double>

Returns:

this assertion object.

isNotNegative

public DoubleAssert isNotNegative()

Verifies that the actual value is non negative (positive or equal zero).

Specified by:

isNotNegative in interface NumberAssert<Double>

Returns:

this assertion object.

isNotPositive

public DoubleAssert isNotPositive()

Verifies that the actual value is non positive (negative or equal zero).

Specified by:

isNotPositive in interface NumberAssert<Double>

Returns:

this assertion object.

isEqualTo

public DoubleAssert isEqualTo(double expected)

Verifies that the actual value is equal to the given one.

Parameters:

expected - the given value to compare the actual value to.

Returns:

this assertion object.

Throws:

AssertionError - if the actual value is null.

AssertionError - if the actual value is not equal to the given one.

isEqualTo

public DoubleAssert isEqualTo(Double expected,
                     Offset<Double> offset)

Verifies that the actual value is equal to the given one, within a positive offset.

Specified by:

isEqualTo in interface FloatingPointNumberAssert<Double>

Parameters:

expected - the given value to compare the actual value to.

offset - the given positive offset.

Returns:

this assertion object.

isEqualTo

public DoubleAssert isEqualTo(double expected,
                     Offset<Double> offset)

Verifies that the actual value is equal to the given one, within a positive offset.

Parameters:

expected - the given value to compare the actual value to.

offset - the given positive offset.

Returns:

this assertion object.

Throws:

NullPointerException - if the given offset is null.

AssertionError - if the actual value is null.

AssertionError - if the actual value is not equal to the given one.

isNotEqualTo

public DoubleAssert isNotEqualTo(double other)

Verifies that the actual value is not equal to the given one.

Parameters:

other - the given value to compare the actual value to.

Returns:

this assertion object.

Throws:

AssertionError - if the actual value is null.

AssertionError - if the actual value is equal to the given one.

isLessThan

public DoubleAssert isLessThan(double other)

Verifies that the actual value is less than the given one.

Parameters:

other - the given value to compare the actual value to.

Returns:

this assertion object.

Throws:

AssertionError - if the actual value is null.

AssertionError - if the actual value is equal to or greater than the given one.

isLessThanOrEqualTo

public DoubleAssert isLessThanOrEqualTo(double other)

Verifies that the actual value is less than or equal to the given one.

Parameters:

other - the given value to compare the actual value to.

Returns:

this assertion object.

Throws:

AssertionError - if the actual value is null.

AssertionError - if the actual value is greater than the given one.

isGreaterThan

public DoubleAssert isGreaterThan(double other)

Verifies that the actual value is greater than the given one.

Parameters:

other - the given value to compare the actual value to.

Returns:

this assertion object.

Throws:

AssertionError - if the actual value is null.

AssertionError - if the actual value is equal to or less than the given one.

isGreaterThanOrEqualTo

public DoubleAssert isGreaterThanOrEqualTo(double other)

Verifies that the actual value is greater than or equal to the given one.

Parameters:

other - the given value to compare the actual value to.

Returns:

this assertion object.

Throws:

AssertionError - if the actual value is null.

AssertionError - if the actual value is less than the given one.

usingComparator

public DoubleAssert usingComparator(Comparator<? super Double> customComparator)

Description copied from class: AbstractAssert

Use given custom comparator instead of relying on actual type A equals method for incoming assertion checks.

Custom comparator is bound to assertion instance, meaning that if a new assertion is created, it will use default comparison strategy.

Examples :

 // frodo and sam are instances of Character with Hobbit race (obviously :).
 // raceComparator implements Comparator<Character> 
 assertThat(frodo).usingComparator(raceComparator).isEqualTo(sam); 
 

Specified by:

usingComparator in interface Assert<DoubleAssert,Double>

Overrides:

usingComparator in class AbstractComparableAssert<DoubleAssert,Double>

Parameters:

customComparator - the comparator to use for incoming assertion checks.

Returns:

this assertion object.

usingDefaultComparator

public DoubleAssert usingDefaultComparator()

Description copied from class: AbstractAssert

Revert to standard comparison for incoming assertion checks.

This method should be used to disable a custom comparison strategy set by calling Assert.usingComparator(Comparator).

Specified by:

usingDefaultComparator in interface Assert<DoubleAssert,Double>

Overrides:

usingDefaultComparator in class AbstractComparableAssert<DoubleAssert,Double>

Returns:

this assertion object.