com.google.common.truth

Class ComparableSubject<S extends ComparableSubject<S,T>,T extends Comparable>

java.lang.Object

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

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

Type Parameters:

S - deprecated - the self-type, allowing this-returning methods to avoid needing subclassing. This type parameter will be removed, as the method that needs it is being removed. You can prepare for this change by editing your class to refer to raw ComparableSubject today and then, after the removal, editing it to refer to ComparableSubject<T> (with a single type parameter).

T - the type of the object being tested by this ComparableSubject

Direct Known Subclasses:

BigDecimalSubject, DoubleSubject, FloatSubject, IntegerSubject, LongSubject, StringSubject

public abstract class ComparableSubject<S extends ComparableSubject<S,T>,T extends Comparable>
extends Subject<S,T>

Propositions for Comparable typed subjects.

Author:

Kurt Alfred Kluever

Nested Class Summary

Nested classes/interfaces inherited from class com.google.common.truth.Subject

Subject.Factory<SubjectT extends Subject,ActualT>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ComparableSubject(FailureMetadata metadata, T actual)

Method Summary

Modifier and Type	Method and Description
void	isAtLeast(T other) Checks that the subject is greater than or equal to other.
void	isAtMost(T other) Checks that the subject is less than or equal to other.
void	isEquivalentAccordingToCompareTo(T expected) Checks that the subject is equivalent to other according to Comparable.compareTo(T), (i.e., checks that a.comparesTo(b) == 0).
void	isGreaterThan(T other) Checks that the subject is greater than other.
void	isIn(Range<T> range) Checks that the subject is in range.
void	isLessThan(T other) Checks that the subject is less than other.
void	isNotIn(Range<T> range) Checks that the subject is not in range.

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

actual, actualAsString, actualCustomStringRepresentation, check, equals, failWithActual, failWithActual, failWithoutActual, getSubject, hashCode, ignoreCheck, internalCustomName, isAnyOf, isEqualTo, isIn, isInstanceOf, isNoneOf, isNotEqualTo, isNotIn, isNotInstanceOf, isNotNull, isNotSameInstanceAs, isNull, isSameInstanceAs, named, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ComparableSubject

protected ComparableSubject(FailureMetadata metadata,
                            @NullableDecl
                            T actual)

Method Detail

isIn

public final void isIn(Range<T> range)

Checks that the subject is in range.

isNotIn

public final void isNotIn(Range<T> range)

Checks that the subject is not in range.

isEquivalentAccordingToCompareTo

public void isEquivalentAccordingToCompareTo(T expected)

Checks that the subject is equivalent to other according to Comparable.compareTo(T), (i.e., checks that a.comparesTo(b) == 0).

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

isGreaterThan

public final void isGreaterThan(T other)

Checks that the subject is greater than other.

Use isAtLeast(T) to check that the subject is greater than or equal to other.

isLessThan

public final void isLessThan(T other)

Checks that the subject is less than other.

Use isAtMost(T) to check that the subject is less than or equal to other.

isAtMost

public final void isAtMost(T other)

Checks that the subject is less than or equal to other.

Use isLessThan(T) to check that the subject is less than other.

isAtLeast

public final void isAtLeast(T other)

Checks that the subject is greater than or equal to other.

Use isGreaterThan(T) to check that the subject is greater than other.