Class ComparableSubject<T extends Comparable<?>>

java.lang.Object

com.google.common.truth.Subject

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

Type Parameters:

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

Direct Known Subclasses:

BigDecimalSubject, DoubleSubject, FloatSubject, IntegerSubject, LongSubject, StringSubject

public class ComparableSubject<T extends Comparable<?>>
extends Subject

A subject for Comparable values.

Nested Class Summary

Nested classes/interfaces inherited from class Subject

Subject.Factory<SubjectT,ActualT>

Modifier and Type	Class	Description
static interface	Subject.Factory<SubjectT extends Subject, ActualT>	In a fluent assertion chain, the argument to the common overload of about, the method that specifies what kind of Subject to create.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ComparableSubject(FailureMetadata metadata, @Nullable T actual)	The constructor is for use by subclasses only.

Method Summary

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

Methods inherited from class Subject

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

Modifier and Type	Method	Description
protected String	actualCustomStringRepresentation()	Returns a string representation of the actual value for inclusion in failure messages.
protected final StandardSubjectBuilder	check(String format, @Nullable Object... args)	Returns a builder for creating a derived subject.
final boolean	equals(@Nullable Object other)	Deprecated. Object.equals(Object) is not supported on Truth subjects.
protected final void	failWithActual(Fact first, Fact... rest)	Fails, reporting a message with the given facts, followed by an automatically added fact of the form: but was: actual value.
protected final void	failWithActual(String key, @Nullable Object value)	Fails, reporting a message with two "facts": key: value but was: actual value.
protected final void	failWithoutActual(Fact first, Fact... rest)	Fails, reporting a message with the given facts, without automatically adding the actual value.
final int	hashCode()	Deprecated. Object.hashCode() is not supported on Truth subjects.
protected final StandardSubjectBuilder	ignoreCheck()	Begins a new call chain that ignores any failures.
void	isAnyOf(@Nullable Object first, @Nullable Object second, @Nullable Object... rest)	Checks that the value under test is equal to any of the given elements.
void	isEqualTo(@Nullable Object expected)	Checks that the value under test is equal to the given object.
void	isIn(@Nullable Iterable<?> iterable)	Checks that the value under test is equal to any element in the given iterable.
void	isInstanceOf(@Nullable Class<?> clazz)	Checks that the value under test is an instance of the given class.
void	isNoneOf(@Nullable Object first, @Nullable Object second, @Nullable Object... rest)	Checks that the value under test is not equal to any of the given elements.
void	isNotEqualTo(@Nullable Object other)	Checks that the value under test is not equal to the given object.
void	isNotIn(@Nullable Iterable<?> iterable)	Checks that the value under test is not equal to any element in the given iterable.
void	isNotInstanceOf(@Nullable Class<?> clazz)	Checks that the value under test is not an instance of the given class.
void	isNotNull()	Checks that the value under test is not null.
final void	isNotSameInstanceAs(@Nullable Object other)	Checks that the value under test is not the same instance as the given object.
void	isNull()	Checks that the value under test is null.
final void	isSameInstanceAs(@Nullable Object expected)	Checks that the value under test is the same instance as the given object.
String	toString()	Deprecated. Object.toString() is not supported on Truth subjects.

Methods inherited from class Object

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

Constructor Details

ComparableSubject

protected ComparableSubject(FailureMetadata metadata,
 @Nullable T actual)

The constructor is for use by subclasses only. If you want to create an instance of this class itself, call check(...).that(actual).

Method Details

isIn

public final void isIn(@Nullable Range<T> range)

Checks that the actual value is in range.

isNotIn

public final void isNotIn(@Nullable Range<T> range)

Checks that the actual value is not in range.

isEquivalentAccordingToCompareTo

public void isEquivalentAccordingToCompareTo(@Nullable T expected)

Checks that the actual value 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(@Nullable T other)

Checks that the actual value is greater than other.

To check that the actual value is greater than or equal to other, use isAtLeast(T).

isLessThan

public final void isLessThan(@Nullable T other)

Checks that the actual value is less than other.

To check that the actual value is less than or equal to other, use isAtMost(T).

isAtMost

public final void isAtMost(@Nullable T other)

Checks that the actual value is less than or equal to other.

To check that the actual value is strictly less than other, use isLessThan(T).

isAtLeast

public final void isAtLeast(@Nullable T other)

Checks that the actual value is greater than or equal to other.

To check that the actual value is strictly greater than other, use isGreaterThan(T).