Class IntegerSubject

java.lang.Object

com.google.common.truth.Subject

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

com.google.common.truth.IntegerSubject

public class IntegerSubject
extends ComparableSubject<Integer>

A subject for Integer values.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	IntegerSubject.TolerantIntegerComparison	A partially specified check about an approximate relationship to a int actual value using a tolerance.

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	IntegerSubject(FailureMetadata metadata, @Nullable Integer actual)	The constructor is for use by subclasses only.

Method Summary

Modifier and Type	Method	Description
final void	isEquivalentAccordingToCompareTo(@Nullable Integer expected)	Deprecated. Use Subject.isEqualTo(Object) instead.
IntegerSubject.TolerantIntegerComparison	isNotWithin(int tolerance)	Prepares for a check that the actual value is a number not within the given tolerance of an expected value that will be provided in the next call in the fluent chain.
IntegerSubject.TolerantIntegerComparison	isWithin(int tolerance)	Prepares for a check that the actual value is a 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 ComparableSubject

isAtLeast, isAtMost, isGreaterThan, isIn, isLessThan, isNotIn

Modifier and Type	Method	Description
final void	isAtLeast(Integer other)	Checks that the actual value is greater than or equal to other.
final void	isAtMost(Integer other)	Checks that the actual value is less than or equal to other.
final void	isGreaterThan(Integer other)	Checks that the actual value is greater than other.
final void	isIn(@Nullable Range<Integer> range)	Checks that the actual value is in range.
final void	isLessThan(Integer other)	Checks that the actual value is less than other.
final void	isNotIn(@Nullable Range<Integer> 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

IntegerSubject

protected IntegerSubject(FailureMetadata metadata,
 @Nullable Integer 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

isWithin

public IntegerSubject.TolerantIntegerComparison isWithin(int tolerance)

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

Parameters:

tolerance - an inclusive upper bound on the difference between the actual value and expected value allowed by the check, which must be a non-negative value.

Since:

1.2

isNotWithin

public IntegerSubject.TolerantIntegerComparison isNotWithin(int tolerance)

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

Parameters:

tolerance - an exclusive lower bound on the difference between the actual value and expected value allowed by the check, which must be a non-negative value.

Since:

1.2

isEquivalentAccordingToCompareTo

@Deprecated
public final void isEquivalentAccordingToCompareTo(@Nullable Integer expected)

Deprecated.

Use Subject.isEqualTo(Object) instead. Integer comparison is consistent with equality.

Description copied from class: ComparableSubject

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).

Overrides:

isEquivalentAccordingToCompareTo in class ComparableSubject<Integer>