org.fest.assertions.api
Class DoubleAssert

java.lang.Object
  extended by org.fest.assertions.api.AbstractAssert<S,A>
      extended by org.fest.assertions.api.AbstractComparableAssert<DoubleAssert,Double>
          extended by org.fest.assertions.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

Field Summary
 
Fields inherited from class org.fest.assertions.api.AbstractAssert
actual, myself
 
Constructor Summary
protected DoubleAssert(Double actual)
           
 
Method Summary
 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 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<?> 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.fest.assertions.api.AbstractComparableAssert
isGreaterThan, isGreaterThanOrEqualTo, isLessThan, isLessThanOrEqualTo
 
Methods inherited from class org.fest.assertions.api.AbstractAssert
as, as, describedAs, describedAs, descriptionText, doesNotHave, equals, has, hashCode, is, isEqualTo, isIn, isIn, isNot, isNotEqualTo, isNotIn, isNotIn, isNotNull, isNotSameAs, isNull, isSameAs
 
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.

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<?> 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.

Example :
 // compares invoices by payee 
 assertThat(invoiceList).usingComparator(invoicePayeeComparator).isEqualTo(expectedInvoiceList).
 
 // compares invoices by date, doesNotHaveDuplicates and contains both use the given invoice date comparator
 assertThat(invoiceList).usingComparator(invoiceDateComparator).doesNotHaveDuplicates().contains(may2010Invoice)
 
 // as assertThat(invoiceList) creates a new assertion, it uses standard comparison strategy (Invoice's equal method) to compare invoiceList elements to lowestInvoice.                                                      
 assertThat(invoiceList).contains(lowestInvoice).
 
Custom comparator is not parameterized with actual type A (ie. Comparator<A>) because if it was, we could not write the following code :
 // frodo and sam are instances of Character (a Character having a Race)
 // raceComparator implements Comparator<Character> 
 // assertThat(frodo) returns an ObjectAssert and not a custom CharacterAssert implementing Assert<CharacterAssert, Character>  
 assertThat(frodo).usingComparator(raceComparator).isEqualTo(sam); // won't compile !
 
 The code does not compile because assertThat(frodo) returns an ObjectAssert, thus usingComparator expects a Comparator<Object> 
 and Comparator<Character> is not a Comparator<Object> as generics are not reified.
 
 Note that, it would have worked if assertThat(frodo) returned a CharacterAssert implementing Assert<CharacterAssert, Character>. 
 

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.


Copyright © 2007-2012 FEST (Fixtures for Easy Software Testing). All Rights Reserved.