com.google.common.truth

Class FloatSubject

java.lang.Object

com.google.common.truth.Subject<S,T>

com.google.common.truth.ComparableSubject<FloatSubject,Float>

com.google.common.truth.FloatSubject

@CheckReturnValue
public final class FloatSubject
extends ComparableSubject<FloatSubject,Float>

Propositions for Float subjects.

Author:

Kurt Alfred Kluever

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	FloatSubject.TolerantFloatComparison A partially specified proposition about an approximate relationship to a float subject using a tolerance.

Field Summary

Fields inherited from class com.google.common.truth.Subject

failureStrategy

Method Summary

Modifier and Type	Method and Description
void	isEqualTo(Float other) Deprecated. Use isWithin(float) instead. Float comparison should always have a tolerance.
void	isEquivalentAccordingToCompareTo(Float other) Deprecated. Use isWithin(float) instead. Float comparison should always have a tolerance.
void	isFinite() Asserts that the subject is finite, i.e.
void	isNaN() Asserts that the subject is Float.NaN.
void	isNegativeInfinity() Asserts that the subject is Float.NEGATIVE_INFINITY.
void	isNotEqualTo(Float other) Deprecated. Use isNotWithin(float) instead. Float comparison should always have a tolerance.
void	isNotNaN() Asserts that the subject is not Float.NaN (but it may be Float.POSITIVE_INFINITY or Float.NEGATIVE_INFINITY).
FloatSubject.TolerantFloatComparison	isNotWithin(float tolerance) Prepares for a check that the subject is a finite number not within the given tolerance of an expected value that will be provided in the next call in the fluent chain.
void	isPositiveInfinity() Asserts that the subject is Float.POSITIVE_INFINITY.
FloatSubject.TolerantFloatComparison	isWithin(float tolerance) Prepares for a check that the subject is a finite number within the given tolerance of an expected value that will be provided in the next call in the fluent chain.

Methods inherited from class com.google.common.truth.ComparableSubject

comparesEqualTo, isAtLeast, isAtMost, isGreaterThan, isIn, isLessThan, isNotIn

Methods inherited from class com.google.common.truth.Subject

check, equals, fail, fail, fail, failWithBadResults, failWithCustomSubject, failWithoutSubject, failWithRawMessage, getDisplaySubject, getSubject, hashCode, internalCustomName, isAnyOf, isEqualTo, isIn, isInstanceOf, isNoneOf, isNotEqualTo, isNotIn, isNotInstanceOf, isNotNull, isNotSameAs, isNull, isSameAs, named

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

isWithin

public FloatSubject.TolerantFloatComparison isWithin(float tolerance)

Prepares for a check that the subject is a finite number within the given tolerance of an expected value that will be provided in the next call in the fluent chain.

You can use a tolerance of 0.0f to assert the exact equality of finite floats. This is appropriate when the contract of the code under test guarantees this, e.g. by specifying that a return value is copied unchanged from the input, by specifying an exact constant value to be returned, or by specifying an exact sequence of arithmetic operations to be followed.

The check will fail if either the subject or the object is Float.POSITIVE_INFINITY, Float.NEGATIVE_INFINITY, or Float.NaN. To check for those values, use isPositiveInfinity(), isNegativeInfinity, or isNaN.

Parameters:

tolerance - an inclusive upper bound on the difference between the subject and object allowed by the check, which must be a non-negative finite value, i.e. not Float.NaN, Float.POSITIVE_INFINITY, or negative, including -0.0f

isNotWithin

public FloatSubject.TolerantFloatComparison isNotWithin(float tolerance)

Prepares for a check that the subject is a finite number not within the given tolerance of an expected value that will be provided in the next call in the fluent chain.

You can use a tolerance of 0.0f to assert the exact inequality of finite floats.

The check will fail if either the subject or the object is Float.POSITIVE_INFINITY, Float.NEGATIVE_INFINITY, or Float.NaN. See isFinite() and isNotNaN(), or use ComparableSubject.isIn(com.google.common.collect.Range<T>) with a suitable Range.

Parameters:

tolerance - an exclusive lower bound on the difference between the subject and object allowed by the check, which must be a non-negative finite value, i.e. not Float.NaN, Float.POSITIVE_INFINITY, or negative, including -0.0f

isEqualTo

@Deprecated
public final void isEqualTo(@Nullable
                                        Float other)

Deprecated. Use isWithin(float) instead. Float comparison should always have a tolerance.

isNotEqualTo

@Deprecated
public final void isNotEqualTo(@Nullable
                                           Float other)

Deprecated. Use isNotWithin(float) instead. Float comparison should always have a tolerance.

isEquivalentAccordingToCompareTo

@Deprecated
public final void isEquivalentAccordingToCompareTo(Float other)

Deprecated. Use isWithin(float) instead. Float comparison should always have a tolerance.

Description copied from class: ComparableSubject

Fails if the subject is not equivalent to the given value according to Comparable.compareTo(T), (i.e., fails if a.comparesTo(b) != 0).

Note: Do not use this method for checking object equality. Instead, use Subject.isEqualTo(Object).

Overrides:

isEquivalentAccordingToCompareTo in class ComparableSubject<FloatSubject,Float>

isPositiveInfinity

public final void isPositiveInfinity()

Asserts that the subject is Float.POSITIVE_INFINITY.

isNegativeInfinity

public final void isNegativeInfinity()

Asserts that the subject is Float.NEGATIVE_INFINITY.

isNaN

public final void isNaN()

Asserts that the subject is Float.NaN.

isFinite

public final void isFinite()

Asserts that the subject is finite, i.e. not Float.POSITIVE_INFINITY, Float.NEGATIVE_INFINITY, or Float.NaN.

isNotNaN

public final void isNotNaN()

Asserts that the subject is not Float.NaN (but it may be Float.POSITIVE_INFINITY or Float.NEGATIVE_INFINITY).