AbstractFloatAssert (AssertJ fluent assertions 2.2.0 API)

java.lang.Object
- org.assertj.core.api.AbstractAssert<S,A>
- - org.assertj.core.api.AbstractObjectAssert<S,A>
  - - org.assertj.core.api.AbstractComparableAssert<S,Float>
    - - org.assertj.core.api.AbstractFloatAssert<S>

Type Parameters:
S - the "self" type of this assertion class. Please read "Emulating 'self types' using Java Generics to simplify fluent API implementation" for more details.

All Implemented Interfaces:

Assert<S,Float>, ComparableAssert<S,Float>, Descriptable<S>, ExtensionPoints<S,Float>, FloatingPointNumberAssert<S,Float>, NumberAssert<S,Float>

Direct Known Subclasses:

FloatAssert
```
public abstract class AbstractFloatAssert<S extends AbstractFloatAssert<S>>
extends AbstractComparableAssert<S,Float>
implements FloatingPointNumberAssert<S,Float>
```
Base class for all implementations of assertions for Floats.

Author:

Yvonne Wang, Alex Ruiz, Ansgar Konermann, 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 AbstractFloatAssert(Float actual, Class<?> selfType)

Constructors
Modifier	Constructor and Description
`protected`	`AbstractFloatAssert(Float actual, Class<?> selfType)`

Method Summary

Methods
Modifier and Type	Method and Description
`S`	`isBetween(Float start, Float end)` Verifies that the actual value is in [start, end] range (start included, end included).
`S`	`isCloseTo(float other, Offset<Float> offset)` Verifies that the actual number is close to the given one within the given offset. If difference is equal to offset value, assertion is considered valid.
`S`	`isCloseTo(Float other, Offset<Float> offset)` Verifies that the actual number is close to the given one within the given offset. If difference is equal to offset value, assertion is considered valid.
`S`	`isCloseTo(float expected, Percentage percentage)` Verifies that the actual number is close to the given one within the given percentage. If difference is equal to the percentage value, assertion is considered valid.
`S`	`isCloseTo(Float expected, Percentage percentage)` Verifies that the actual number is close to the given one within the given percentage. If difference is equal to the percentage value, assertion is considered valid.
`S`	`isEqualTo(float expected)` Verifies that the actual value is equal to the given one.
`S`	`isEqualTo(float expected, Offset<Float> offset)` Verifies that the actual value is close to the given one by less than the given offset. If difference is equal to offset value, assertion is considered valid.
`S`	`isEqualTo(Float expected, Offset<Float> offset)` Verifies that the actual value is close to the given one by less than the given offset. If difference is equal to offset value, assertion is considered valid.
`S`	`isGreaterThan(float other)` Verifies that the actual value is greater than the given one.
`S`	`isGreaterThanOrEqualTo(float other)` Verifies that the actual value is greater than or equal to the given one.
`S`	`isLessThan(float other)` Verifies that the actual value is less than the given one.
`S`	`isLessThanOrEqualTo(float other)` Verifies that the actual value is less than or equal to the given one.
`S`	`isNaN()` Verifies that the actual value is equal to `NaN`.
`S`	`isNegative()` Verifies that the actual value is negative.
`S`	`isNotEqualTo(float other)` Verifies that the actual value is not equal to the given one.
`S`	`isNotNaN()` Verifies that the actual value is not equal to `NaN`.
`S`	`isNotNegative()` Verifies that the actual value is non negative (positive or equal zero).
`S`	`isNotPositive()` Verifies that the actual value is non positive (negative or equal zero).
`S`	`isNotZero()` Verifies that the actual value is not equal to zero.
`S`	`isPositive()` Verifies that the actual value is positive.
`S`	`isStrictlyBetween(Float start, Float end)` Verifies that the actual value is in ]start, end[ range (start excluded, end excluded).
`S`	`isZero()` Verifies that the actual value is equal to zero.
`S`	`usingComparator(Comparator<? super Float> customComparator)` Use given custom comparator instead of relying on actual type A equals method for incoming assertion checks.
`S`	`usingDefaultComparator()` Revert to standard comparison for incoming assertion checks.

Methods inherited from class org.assertj.core.api.AbstractComparableAssert
inBinary, inHexadecimal, isEqualByComparingTo, isGreaterThan, isGreaterThanOrEqualTo, isLessThan, isLessThanOrEqualTo, isNotEqualByComparingTo

Methods inherited from class org.assertj.core.api.AbstractObjectAssert
isEqualToComparingFieldByField, isEqualToComparingOnlyGivenFields, isEqualToIgnoringGivenFields, isEqualToIgnoringNullFields

Methods inherited from class org.assertj.core.api.AbstractAssert
as, as, asList, asString, describedAs, describedAs, descriptionText, doesNotHave, doesNotHaveSameClassAs, equals, failWithMessage, getWritableAssertionInfo, has, hashCode, hasSameClassAs, hasToString, is, isEqualTo, isExactlyInstanceOf, isIn, isIn, isInstanceOf, isInstanceOfAny, isNot, isNotEqualTo, isNotExactlyInstanceOf, isNotIn, isNotIn, isNotInstanceOf, isNotInstanceOfAny, isNotNull, isNotOfAnyClassIn, isNotSameAs, isNull, isOfAnyClassIn, isSameAs, overridingErrorMessage, withFailMessage, withThreadDumpOnError

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AbstractFloatAssert
```
protected AbstractFloatAssert(Float actual,
                   Class<?> selfType)
```
- Method Detail
  - isNaN
```
public S isNaN()
```
    Verifies that the actual value is equal to NaN.
    
    Specified by:
    
    isNaN in interface FloatingPointNumberAssert<S extends AbstractFloatAssert<S>,Float>
    
    Returns:
    this assertion object.
  - isNotNaN
```
public S isNotNaN()
```
    Verifies that the actual value is not equal to NaN.
    
    Specified by:
    
    isNotNaN in interface FloatingPointNumberAssert<S extends AbstractFloatAssert<S>,Float>
    
    Returns:
    this assertion object.
  - isZero
```
public S isZero()
```
    Verifies that the actual value is equal to zero.
    
    Specified by:
    
    isZero in interface NumberAssert<S extends AbstractFloatAssert<S>,Float>
    
    Returns:
    this assertion object.
  - isNotZero
```
public S isNotZero()
```
    Verifies that the actual value is not equal to zero.
    
    Specified by:
    
    isNotZero in interface NumberAssert<S extends AbstractFloatAssert<S>,Float>
    
    Returns:
    this assertion object.
  - isPositive
```
public S isPositive()
```
    Verifies that the actual value is positive.
    
    Specified by:
    
    isPositive in interface NumberAssert<S extends AbstractFloatAssert<S>,Float>
    
    Returns:
    this assertion object.
  - isNegative
```
public S isNegative()
```
    Verifies that the actual value is negative.
    
    Specified by:
    
    isNegative in interface NumberAssert<S extends AbstractFloatAssert<S>,Float>
    
    Returns:
    this assertion object.
  - isNotNegative
```
public S isNotNegative()
```
    Verifies that the actual value is non negative (positive or equal zero).
    
    Specified by:
    
    isNotNegative in interface NumberAssert<S extends AbstractFloatAssert<S>,Float>
    
    Returns:
    this assertion object.
  - isNotPositive
```
public S isNotPositive()
```
    Verifies that the actual value is non positive (negative or equal zero).
    
    Specified by:
    
    isNotPositive in interface NumberAssert<S extends AbstractFloatAssert<S>,Float>
    
    Returns:
    this assertion object.
  - isEqualTo
```
public S 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.
  - isCloseTo
```
public S isCloseTo(float other,
          Offset<Float> offset)
```
    Verifies that the actual number is close to the given one within the given offset.
    If difference is equal to offset value, assertion is considered valid.
    Example:
```
 // assertion will pass:
 assertThat(8.1f).isCloseTo(8.2f, within(0.2f));

 // you can use offset if you prefer
 assertThat(8.1f).isCloseTo(8.2f, offset(0.2f));

 // if difference is exactly equals to 0.1, it's ok
 assertThat(8.1f).isCloseTo(8.2f, within(0.1f));

 // assertion will fail
 assertThat(8.1f).isCloseTo(8.2f, within(0.01f));
```
    Beware that java floating point number precision might have some unexpected behavior, e.g. the assertion below fails:
```
  // fails because 8.1f - 8.0f is evaluated to 0.10000038f in java.
 assertThat(8.1f).isCloseTo(8.0f, within(0.1f));
```
    Parameters:
    other - the given number 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 not equal to the given one.
  - isCloseTo
```
public S isCloseTo(Float other,
          Offset<Float> offset)
```
    Verifies that the actual number is close to the given one within the given offset.
    If difference is equal to offset value, assertion is considered valid.
    Example:
```
 // assertion will pass:
 assertThat(8.1f).isCloseTo(new Float(8.2f), within(0.2f));

 // you can use offset if you prefer
 assertThat(8.1f).isCloseTo(new Float(8.2f), offset(0.2f));

 // if difference is exactly equals to the offset (0.1), it's ok
 assertThat(8.1f).isCloseTo(new Float(8.2f), within(0.1f));

 // assertion will fail
 assertThat(8.1f).isCloseTo(new Float(8.2f), within(0.01f));
```
    Beware that java floating point number precision might have some unexpected behavior, e.g. the assertion below fails:
```
  // fails because 8.1f - 8.0f is evaluated to 0.10000038f in java.
 assertThat(8.1f).isCloseTo(new Float(8.0f), within(0.1f));
```
    Specified by:
    
    isCloseTo in interface FloatingPointNumberAssert<S extends AbstractFloatAssert<S>,Float>
    
    Specified by:
    
    isCloseTo in interface NumberAssert<S extends AbstractFloatAssert<S>,Float>
    
    Parameters:
    other - the given number to compare the actual value to.
    offset - the given positive offset.
    
    Returns:
    this assertion object.
    
    Throws:
    
    NullPointerException - if the given offset is null.
    
    NullPointerException - if the other number is null.
    
    AssertionError - if the actual value is not equal to the given one.
  - isCloseTo
```
public S isCloseTo(Float expected,
          Percentage percentage)
```
    Verifies that the actual number is close to the given one within the given percentage.
    If difference is equal to the percentage value, assertion is considered valid.
    Example with float:
```
 // assertions will pass:
 assertThat(11.0f).isCloseTo(new Float(10.0f), withinPercentage(20f));

 // if difference is exactly equals to the computed offset (1.0), it's ok
 assertThat(11.0f).isCloseTo(new Float(10.0f), withinPercentage(10f));

 // assertion will fail
 assertThat(11.0f).isCloseTo(new Float(10.0f), withinPercentage(5f));
```
    Specified by:
    
    isCloseTo in interface NumberAssert<S extends AbstractFloatAssert<S>,Float>
    
    Parameters:
    expected - the given number to compare the actual value to.
    percentage - the given positive percentage between 0 and 100.
    
    Returns:
    this assertion object.
    
    Throws:
    
    NullPointerException - if the given offset is null.
    
    NullPointerException - if the expected number is null.
    
    AssertionError - if the actual value is not equal to the given one.
  - isCloseTo
```
public S isCloseTo(float expected,
          Percentage percentage)
```
    Verifies that the actual number is close to the given one within the given percentage.
    If difference is equal to the percentage value, assertion is considered valid.
    Example with float:
```
 // assertions will pass:
 assertThat(11.0f).isCloseTo(10.0f, withinPercentage(20f));

 // if difference is exactly equals to the computed offset (1.0), it's ok
 assertThat(11.0f).isCloseTo(10.0f, withinPercentage(10f));

 // assertion will fail
 assertThat(11.0f).isCloseTo(10.0f, withinPercentage(5f));
```
    Parameters:
    expected - the given number to compare the actual value to.
    percentage - the given positive percentage between 0 and 100.
    
    Returns:
    this assertion object.
    
    Throws:
    
    NullPointerException - if the given offset is null.
    
    NullPointerException - if the expected number is null.
    
    AssertionError - if the actual value is not equal to the given one.
  - isEqualTo
```
public S isEqualTo(Float expected,
          Offset<Float> offset)
```
    Verifies that the actual value is close to the given one by less than the given offset.
    If difference is equal to offset value, assertion is considered valid.
    Example with double:
```
 // assertion will pass:
 assertThat(8.1).isEqualTo(new Double(8.0), offset(0.2));

 // if difference is exactly equals to the offset (0.1), it's ok
 assertThat(8.1).isEqualTo(new Double(8.0), offset(0.1));

 // within is an alias of offset
 assertThat(8.1).isEqualTo(new Double(8.0), within(0.1));

 // assertion will fail
 assertThat(8.1).isEqualTo(new Double(8.0), offset(0.01));
```
    Specified by:
    
    isEqualTo in interface FloatingPointNumberAssert<S extends AbstractFloatAssert<S>,Float>
    
    Parameters:
    expected - the given value to compare the actual value to.
    offset - the given positive offset.
    
    Returns:
    this assertion object.
  - isEqualTo
```
public S isEqualTo(float expected,
          Offset<Float> offset)
```
    Verifies that the actual value is close to the given one by less than the given offset.
    If difference is equal to offset value, assertion is considered valid.
    Example:
```
 // assertion will pass
 assertThat(8.1f).isEqualTo(8.2f, offset(0.1f));

 // within is an alias of offset
 assertThat(8.1f).isEqualTo(8.2f, within(0.1f));

 // assertion will fail
 assertThat(8.1f).isEqualTo(8.2f, offset(0.01f));
```
    Beware that java floating point number precision might have some unexpected behavior, e.g. the assertion below fails:
```
  // fails because 8.1f - 8.0f is evaluated to 0.10000038f in java.
 assertThat(8.1f).isEqualTo(8.0f, offset(0.1f));
```
    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 S 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 S 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 S 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 S 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 S 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.
  - isBetween
```
public S isBetween(Float start,
          Float end)
```
    Verifies that the actual value is in [start, end] range (start included, end included).
```
 // these assertions succeed ...
 assertThat(12).isBetween(10, 14);
 assertThat(12).isBetween(12, 14);
 assertThat(12).isBetween(10, 12);
 
 // ... but these one fails
 assertThat(12).isBetween(14, 16);
```
    Specified by:
    
    isBetween in interface NumberAssert<S extends AbstractFloatAssert<S>,Float>
    
    Parameters:
    start - the start value (inclusive), expected not to be null.
    end - the end value (inclusive), expected not to be null.
    
    Returns:
    this assertion object.
  - isStrictlyBetween
```
public S isStrictlyBetween(Float start,
                  Float end)
```
    Verifies that the actual value is in ]start, end[ range (start excluded, end excluded).
```
 // this assertion succeeds ...
 assertThat(12).isBetween(10, 14);
 
 // ... but these one fails
 assertThat(12).isBetween(12, 14);
 assertThat(12).isBetween(10, 12);
 assertThat(12).isBetween(16, 18);
```
    Specified by:
    
    isStrictlyBetween in interface NumberAssert<S extends AbstractFloatAssert<S>,Float>
    
    Parameters:
    start - the start value (exclusive), expected not to be null.
    end - the end value (exclusive), expected not to be null.
    
    Returns:
    this assertion object.
  - usingComparator
```
public S usingComparator(Comparator<? super 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<S extends AbstractFloatAssert<S>,Float>
    
    Overrides:
    
    usingComparator in class AbstractComparableAssert<S extends AbstractFloatAssert<S>,Float>
    
    Parameters:
    customComparator - the comparator to use for incoming assertion checks.
    
    Returns:
    this assertion object.
  - usingDefaultComparator
```
public S 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<S extends AbstractFloatAssert<S>,Float>
    
    Overrides:
    
    usingDefaultComparator in class AbstractComparableAssert<S extends AbstractFloatAssert<S>,Float>
    
    Returns:
    this assertion object.

Class AbstractFloatAssert<S extends AbstractFloatAssert<S>>

Field Summary

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

Constructor Summary

Method Summary

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

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

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

Methods inherited from class java.lang.Object

Constructor Detail

AbstractFloatAssert

Method Detail

isNaN

isNotNaN

isZero

isNotZero

isPositive

isNegative

isNotNegative

isNotPositive

isEqualTo

isCloseTo

isCloseTo

isCloseTo

isCloseTo

isEqualTo

isEqualTo

isNotEqualTo

isLessThan

isLessThanOrEqualTo

isGreaterThan

isGreaterThanOrEqualTo

isBetween

isStrictlyBetween

usingComparator

usingDefaultComparator