S
- the "self" type of this assertion class. Please read "Emulating 'self types' using Java Generics to simplify fluent API implementation"
for more details.public abstract class AbstractFloatAssert<S extends AbstractFloatAssert<S>> extends AbstractComparableAssert<S,Float> implements FloatingPointNumberAssert<S,Float>
Float
s.actual, info, myself
Constructor and Description |
---|
AbstractFloatAssert(Float actual,
Class<?> selfType) |
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.
|
inBinary, inHexadecimal, isEqualByComparingTo, isGreaterThan, isGreaterThanOrEqualTo, isLessThan, isLessThanOrEqualTo, isNotEqualByComparingTo
defaultTypeComparators, extracting, extracting, hasFieldOrProperty, hasFieldOrPropertyWithValue, hasNoNullFieldsOrProperties, hasNoNullFieldsOrPropertiesExcept, isEqualToComparingFieldByField, isEqualToComparingFieldByFieldRecursively, isEqualToComparingOnlyGivenFields, isEqualToIgnoringGivenFields, isEqualToIgnoringNullFields, usingComparatorForFields, usingComparatorForType
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, matches, matches, overridingErrorMessage, satisfies, setCustomRepresentation, throwAssertionError, withFailMessage, withRepresentation, withThreadDumpOnError
public S isNaN()
NaN
.
Example:
// assertions will pass
assertThat(Double.NaN).isNaN();
assertThat(0.0 / 0.0).isNaN();
assertThat(0.0F * Float.POSITIVE_INFINITY).isNaN();
// assertions will fail
assertThat(1.0).isNaN();
assertThat(-1.0F).isNaN();
isNaN
in interface FloatingPointNumberAssert<S extends AbstractFloatAssert<S>,Float>
public S isNotNaN()
NaN
.
Example:
// assertions will pass
assertThat(1.0).isNotNaN();
assertThat(-1.0F).isNotNaN();
// assertions will fail
assertThat(Double.NaN).isNotNaN();
assertThat(0.0 / 0.0).isNotNaN();
assertThat(0.0F * Float.POSITIVE_INFINITY).isNotNaN();
isNotNaN
in interface FloatingPointNumberAssert<S extends AbstractFloatAssert<S>,Float>
public S isZero()
Example:
// assertions will pass
assertThat(0).isZero();
assertThat(0.0).isZero();
// assertions will fail
assertThat(42).isZero();
assertThat(3.142).isZero();
isZero
in interface NumberAssert<S extends AbstractFloatAssert<S>,Float>
public S isNotZero()
Example:
// assertions will pass
assertThat(42).isNotZero();
assertThat(3.142).isNotZero();
// assertions will fail
assertThat(0).isNotZero();
assertThat(0.0).isNotZero();
isNotZero
in interface NumberAssert<S extends AbstractFloatAssert<S>,Float>
public S isPositive()
Example:
// assertions will pass
assertThat(42).isPositive();
assertThat(3.142).isPositive();
// assertions will fail
assertThat(0).isPositive();
assertThat(-42).isPositive();
isPositive
in interface NumberAssert<S extends AbstractFloatAssert<S>,Float>
public S isNegative()
Example:
// assertions will pass
assertThat(-42).isNegative();
assertThat(-3.124).isNegative();
// assertions will fail
assertThat(0).isNegative();
assertThat(42).isNegative();
isNegative
in interface NumberAssert<S extends AbstractFloatAssert<S>,Float>
public S isNotNegative()
Example:
// assertions will pass
assertThat(42).isNotNegative();
assertThat(0).isNotNegative();
// assertions will fail
assertThat(-42).isNotNegative();
assertThat(-3.124).isNotNegative();
isNotNegative
in interface NumberAssert<S extends AbstractFloatAssert<S>,Float>
this
assertion object.public S isNotPositive()
Example:
// assertions will pass
assertThat(-42).isNotPositive();
assertThat(0).isNotPositive();
// assertions will fail
assertThat(42).isNotPositive();
assertThat(3.124).isNotPositive();
isNotPositive
in interface NumberAssert<S extends AbstractFloatAssert<S>,Float>
this
assertion object.public S isEqualTo(float expected)
Example:
// assertions will pass:
assertThat(1.0f).isEqualTo(1.0f);
assertThat(1f).isEqualTo(1.0f);
// assertions will fail:
assertThat(0.0f).isEqualTo(1.0f);
assertThat(-1.0f).isEqualTo(1.0f);
expected
- the given value to compare the actual value to.this
assertion object.AssertionError
- if the actual value is null
.AssertionError
- if the actual value is not equal to the given one.public S isCloseTo(float other, Offset<Float> offset)
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));
other
- the given number to compare the actual value to.offset
- the given positive offset.this
assertion object.NullPointerException
- if the given offset is null
.AssertionError
- if the actual value is not equal to the given one.public S isCloseTo(Float other, Offset<Float> offset)
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));
isCloseTo
in interface FloatingPointNumberAssert<S extends AbstractFloatAssert<S>,Float>
isCloseTo
in interface NumberAssert<S extends AbstractFloatAssert<S>,Float>
other
- the given number to compare the actual value to.offset
- the given positive offset.this
assertion object.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.public S isCloseTo(Float expected, Percentage percentage)
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));
isCloseTo
in interface NumberAssert<S extends AbstractFloatAssert<S>,Float>
expected
- the given number to compare the actual value to.percentage
- the given positive percentage.this
assertion object.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.public S isCloseTo(float expected, Percentage percentage)
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));
expected
- the given number to compare the actual value to.percentage
- the given positive percentage.this
assertion object.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.public S isEqualTo(Float expected, Offset<Float> offset)
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));
isEqualTo
in interface FloatingPointNumberAssert<S extends AbstractFloatAssert<S>,Float>
expected
- the given value to compare the actual value to.offset
- the given positive offset.this
assertion object.public S isEqualTo(float expected, Offset<Float> offset)
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));
expected
- the given value to compare the actual value to.offset
- the given positive offset.this
assertion object.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.public S isNotEqualTo(float other)
Example:
// assertions will pass:
assertThat(0.0f).isNotEqualTo(1.0f);
assertThat(-1.0f).isNotEqualTo(1.0f);
// assertions will fail:
assertThat(1.0f).isNotEqualTo(1.0f);
assertThat(1f).isNotEqualTo(1.0f);
other
- the given value to compare the actual value to.this
assertion object.AssertionError
- if the actual value is null
.AssertionError
- if the actual value is equal to the given one.public S isLessThan(float other)
Example:
// assertions will pass:
assertThat(1.0f).isLessThan(2.0f);
assertThat(1.0f).isLessThan(1.01f);
// assertions will fail:
assertThat(2.0f).isLessThan(1.0f);
assertThat(1.0f).isLessThan(1.0f);
other
- the given value to compare the actual value to.this
assertion object.AssertionError
- if the actual value is null
.AssertionError
- if the actual value is equal to or greater than the given one.public S isLessThanOrEqualTo(float other)
Example:
// assertions will pass:
assertThat(-1.0f).isLessThanOrEqualTo(1.0f);
assertThat(1.0f).isLessThanOrEqualTo(1.0f);
// assertion will fail:
assertThat(2.0f).isLessThanOrEqualTo(1.0f);
other
- the given value to compare the actual value to.this
assertion object.AssertionError
- if the actual value is null
.AssertionError
- if the actual value is greater than the given one.public S isGreaterThan(float other)
Example:
// assertions will pass:
assertThat(2.0f).isGreaterThan(1.0f);
assertThat(2.0f).isGreaterThan(1.99f);
// assertions will fail:
assertThat(1.0f).isGreaterThan(1.0f);
assertThat(1.0f).isGreaterThan(2.0f);
other
- the given value to compare the actual value to.this
assertion object.AssertionError
- if the actual value is null
.AssertionError
- if the actual value is equal to or less than the given one.public S isGreaterThanOrEqualTo(float other)
Example:
// assertions will pass:
assertThat(2.0f).isGreaterThanOrEqualTo(1.0f);
assertThat(1.0f).isGreaterThanOrEqualTo(1.0f);
// assertions will fail:
assertThat(1.0f).isGreaterThanOrEqualTo(2.0f);
assertThat(1.0f).isGreaterThanOrEqualTo(0.99f);
other
- the given value to compare the actual value to.this
assertion object.AssertionError
- if the actual value is null
.AssertionError
- if the actual value is less than the given one.public S isBetween(Float start, Float end)
// assertions succeed
assertThat('b').isBetween('a', 'c');
assertThat('a').isBetween('a', 'b');
assertThat('b').isBetween('a', 'b');
// assertions fail
assertThat('a').isBetween('b', 'c');
assertThat('c').isBetween('a', 'b');
isBetween
in interface ComparableAssert<S extends AbstractFloatAssert<S>,Float>
isBetween
in interface NumberAssert<S extends AbstractFloatAssert<S>,Float>
isBetween
in class AbstractComparableAssert<S extends AbstractFloatAssert<S>,Float>
start
- the start value (inclusive), expected not to be null.end
- the end value (inclusive), expected not to be null.public S isStrictlyBetween(Float start, Float end)
// assertion succeeds
assertThat('b').isStrictlyBetween('a', 'c');
// assertions fail
assertThat('d').isStrictlyBetween('a', 'c');
assertThat('a').isStrictlyBetween('b', 'd');
assertThat('a').isStrictlyBetween('a', 'b');
assertThat('b').isStrictlyBetween('a', 'b');
isStrictlyBetween
in interface ComparableAssert<S extends AbstractFloatAssert<S>,Float>
isStrictlyBetween
in interface NumberAssert<S extends AbstractFloatAssert<S>,Float>
isStrictlyBetween
in class AbstractComparableAssert<S extends AbstractFloatAssert<S>,Float>
start
- the start value (exclusive), expected not to be null.end
- the end value (exclusive), expected not to be null.public S usingComparator(Comparator<? super Float> customComparator)
AbstractAssert
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);
usingComparator
in interface Assert<S extends AbstractFloatAssert<S>,Float>
usingComparator
in class AbstractComparableAssert<S extends AbstractFloatAssert<S>,Float>
customComparator
- the comparator to use for incoming assertion checks.this
assertion object.public S usingDefaultComparator()
AbstractAssert
This method should be used to disable a custom comparison strategy set by calling
Assert.usingComparator(Comparator)
.
usingDefaultComparator
in interface Assert<S extends AbstractFloatAssert<S>,Float>
usingDefaultComparator
in class AbstractComparableAssert<S extends AbstractFloatAssert<S>,Float>
this
assertion object.Copyright © 2014–2016 AssertJ. All rights reserved.