org.fest.assertions.api
Class FloatAssert

java.lang.Object
  extended by org.fest.assertions.api.AbstractAssert<S,A>
      extended by org.fest.assertions.api.AbstractComparableAssert<FloatAssert,Float>
          extended by org.fest.assertions.api.FloatAssert
All Implemented Interfaces:
Assert<FloatAssert,Float>, ComparableAssert<FloatAssert,Float>, Descriptable<FloatAssert>, ExtensionPoints<FloatAssert,Float>, FloatingPointNumberAssert<Float>, NumberAssert<Float>

public class FloatAssert
extends AbstractComparableAssert<FloatAssert,Float>
implements FloatingPointNumberAssert<Float>

Assertion methods for floats.

To create an instance of this class, invoke Assertions.assertThat(Float) or Assertions.assertThat(float).

Author:
Yvonne Wang, Alex Ruiz, Ansgar Konermann

Field Summary
 
Fields inherited from class org.fest.assertions.api.AbstractAssert
actual, myself
 
Constructor Summary
protected FloatAssert(Float actual)
           
 
Method Summary
 FloatAssert isEqualTo(float expected)
          Verifies that the actual value is equal to the given one.
 FloatAssert isEqualTo(float expected, Offset<Float> offset)
          Verifies that the actual value is equal to the given one, within a positive offset.
 FloatAssert isEqualTo(Float expected, Offset<Float> offset)
          Verifies that the actual value is equal to the given one, within a positive offset.
 FloatAssert isGreaterThan(float other)
          Verifies that the actual value is greater than the given one.
 FloatAssert isGreaterThanOrEqualTo(float other)
          Verifies that the actual value is greater than or equal to the given one.
 FloatAssert isLessThan(float other)
          Verifies that the actual value is less than the given one.
 FloatAssert isLessThanOrEqualTo(float other)
          Verifies that the actual value is less than or equal to the given one.
 FloatAssert isNaN()
          Verifies that the actual value is equal to NaN.
 FloatAssert isNegative()
          Verifies that the actual value is negative.
 FloatAssert isNotEqualTo(float other)
          Verifies that the actual value is not equal to the given one.
 FloatAssert isNotNaN()
          Verifies that the actual value is not equal to NaN.
 FloatAssert isNotZero()
          Verifies that the actual value is not equal to zero.
 FloatAssert isPositive()
          Verifies that the actual value is positive.
 FloatAssert isZero()
          Verifies that the actual value is equal to zero.
 FloatAssert usingComparator(Comparator<?> customComparator)
          Use given custom comparator instead of relying on actual type A equals method for incoming assertion checks.
 FloatAssert 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

FloatAssert

protected FloatAssert(Float actual)
Method Detail

isNaN

public FloatAssert isNaN()
Verifies that the actual value is equal to NaN.

Specified by:
isNaN in interface FloatingPointNumberAssert<Float>
Returns:
this assertion object.

isNotNaN

public FloatAssert isNotNaN()
Verifies that the actual value is not equal to NaN.

Specified by:
isNotNaN in interface FloatingPointNumberAssert<Float>
Returns:
this assertion object.

isZero

public FloatAssert isZero()
Verifies that the actual value is equal to zero.

Specified by:
isZero in interface NumberAssert<Float>
Returns:
this assertion object.

isNotZero

public FloatAssert isNotZero()
Verifies that the actual value is not equal to zero.

Specified by:
isNotZero in interface NumberAssert<Float>
Returns:
this assertion object.

isPositive

public FloatAssert isPositive()
Verifies that the actual value is positive.

Specified by:
isPositive in interface NumberAssert<Float>
Returns:
this assertion object.

isNegative

public FloatAssert isNegative()
Verifies that the actual value is negative.

Specified by:
isNegative in interface NumberAssert<Float>
Returns:
this assertion object.

isEqualTo

public FloatAssert isEqualTo(float 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 FloatAssert isEqualTo(Float expected,
                             Offset<Float> offset)
Verifies that the actual value is equal to the given one, within a positive offset.

Specified by:
isEqualTo in interface FloatingPointNumberAssert<Float>
Parameters:
expected - the given value to compare the actual value to.
offset - the given positive offset.
Returns:
this assertion object.

isEqualTo

public FloatAssert isEqualTo(float expected,
                             Offset<Float> 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 FloatAssert isNotEqualTo(float 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 FloatAssert isLessThan(float 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 FloatAssert isLessThanOrEqualTo(float 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 FloatAssert isGreaterThan(float 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 FloatAssert isGreaterThanOrEqualTo(float 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 FloatAssert 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<FloatAssert,Float>
Overrides:
usingComparator in class AbstractComparableAssert<FloatAssert,Float>
Parameters:
customComparator - the comparator to use for incoming assertion checks.
Returns:
this assertion object.

usingDefaultComparator

public FloatAssert 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<FloatAssert,Float>
Overrides:
usingDefaultComparator in class AbstractComparableAssert<FloatAssert,Float>
Returns:
this assertion object.


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