Package org.fest.assertions.api

Class FloatAssert

java.lang.Object

org.fest.assertions.api.AbstractAssert<S,A>

org.fest.assertions.api.AbstractComparableAssert<FloatAssert,java.lang.Float>

org.fest.assertions.api.FloatAssert

All Implemented Interfaces:

Assert<FloatAssert,java.lang.Float>, ComparableAssert<FloatAssert,java.lang.Float>, Descriptable<FloatAssert>, ExtensionPoints<FloatAssert,java.lang.Float>, FloatingPointNumberAssert<java.lang.Float>, NumberAssert<java.lang.Float>

public class FloatAssert
extends AbstractComparableAssert<FloatAssert,java.lang.Float>
implements FloatingPointNumberAssert<java.lang.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, Mikhail Mazursky, Nicolas François

Field Summary

Fields inherited from class org.fest.assertions.api.AbstractAssert

actual, myself

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FloatAssert(java.lang.Float actual)

Method Summary

Modifier and Type	Method	Description
FloatAssert	isEqualTo(float expected)	Verifies that the actual value is equal to the given one.
FloatAssert	isEqualTo(float expected, Offset<java.lang.Float> offset)	Verifies that the actual value is equal to the given one, within a positive offset.
FloatAssert	isEqualTo(java.lang.Float expected, Offset<java.lang.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	isNotNegative()	Verifies that the actual value is non negative (positive or equal zero).
FloatAssert	isNotPositive()	Verifies that the actual value is non positive (negative or equal zero).
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(java.util.Comparator<? super java.lang.Float> 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, doesNotHaveSameClassAs, equals, 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

FloatAssert

protected FloatAssert(java.lang.Float actual)

Method Detail

isNaN

public FloatAssert isNaN()

Verifies that the actual value is equal to NaN.

Specified by:

isNaN in interface FloatingPointNumberAssert<java.lang.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<java.lang.Float>

Returns:

this assertion object.

isZero

public FloatAssert isZero()

Verifies that the actual value is equal to zero.

Specified by:

isZero in interface NumberAssert<java.lang.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<java.lang.Float>

Returns:

this assertion object.

isPositive

public FloatAssert isPositive()

Verifies that the actual value is positive.

Specified by:

isPositive in interface NumberAssert<java.lang.Float>

Returns:

this assertion object.

isNegative

public FloatAssert isNegative()

Verifies that the actual value is negative.

Specified by:

isNegative in interface NumberAssert<java.lang.Float>

Returns:

this assertion object.

isNotNegative

public FloatAssert isNotNegative()

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

Specified by:

isNotNegative in interface NumberAssert<java.lang.Float>

Returns:

this assertion object.

isNotPositive

public FloatAssert isNotPositive()

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

Specified by:

isNotPositive in interface NumberAssert<java.lang.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:

java.lang.AssertionError - if the actual value is null.

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

isEqualTo

public FloatAssert isEqualTo(java.lang.Float expected,
                             Offset<java.lang.Float> offset)

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

Specified by:

isEqualTo in interface FloatingPointNumberAssert<java.lang.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<java.lang.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:

java.lang.NullPointerException - if the given offset is null.

java.lang.AssertionError - if the actual value is null.

java.lang.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:

java.lang.AssertionError - if the actual value is null.

java.lang.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:

java.lang.AssertionError - if the actual value is null.

java.lang.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:

java.lang.AssertionError - if the actual value is null.

java.lang.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:

java.lang.AssertionError - if the actual value is null.

java.lang.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:

java.lang.AssertionError - if the actual value is null.

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

usingComparator

public FloatAssert usingComparator(java.util.Comparator<? super java.lang.Float> 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<FloatAssert,java.lang.Float>

Overrides:

usingComparator in class AbstractComparableAssert<FloatAssert,java.lang.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,java.lang.Float>

Overrides:

usingDefaultComparator in class AbstractComparableAssert<FloatAssert,java.lang.Float>

Returns:

this assertion object.