Class BigDecimalSubject

java.lang.Object

com.google.common.truth.Subject

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

com.google.common.truth.BigDecimalSubject

public final class BigDecimalSubject
extends ComparableSubject<BigDecimal>

A subject for BigDecimal 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.

Method Summary

Modifier and Type	Method	Description
void	isEqualTo(@Nullable Object expected)	Checks that the actual value (including scale) is equal to the given BigDecimal.
void	isEqualToIgnoringScale(long expected)	Checks that the actual value is equal to the value of the BigDecimal created from the expected long (i.e., checks that actual.compareTo(new BigDecimal(expected)) == 0).
void	isEqualToIgnoringScale(String expected)	Checks that the actual value is equal to the value of the BigDecimal created from the expected string (i.e., checks that actual.compareTo(new BigDecimal(expected)) == 0).
void	isEqualToIgnoringScale(@Nullable BigDecimal expected)	Checks that the actual value is equal to the value of the given BigDecimal.
void	isEquivalentAccordingToCompareTo(@Nullable BigDecimal expected)	Checks that the actual value is equivalent to the given value according to Comparable.compareTo(T), (i.e., checks that a.compareTo(b) == 0).

Methods inherited from class ComparableSubject

isAtLeast, isAtMost, isGreaterThan, isIn, isLessThan, isNotIn

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

Methods inherited from class Subject

actualCustomStringRepresentation, check, equals, failWithActual, failWithActual, failWithoutActual, hashCode, ignoreCheck, isAnyOf, 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	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

Method Details

isEqualToIgnoringScale

public void isEqualToIgnoringScale(@Nullable BigDecimal expected)

Checks that the actual value is equal to the value of the given BigDecimal. (i.e., checks that actual.compareTo(expected) == 0).

Note: The scale of the BigDecimal is ignored. If you want to compare the values and the scales, use isEqualTo(Object).

isEqualToIgnoringScale

public void isEqualToIgnoringScale(String expected)

Checks that the actual value is equal to the value of the BigDecimal created from the expected string (i.e., checks that actual.compareTo(new BigDecimal(expected)) == 0).

Note: The scale of the BigDecimal is ignored. If you want to compare the values and the scales, use isEqualTo(Object).

isEqualToIgnoringScale

public void isEqualToIgnoringScale(long expected)

Checks that the actual value is equal to the value of the BigDecimal created from the expected long (i.e., checks that actual.compareTo(new BigDecimal(expected)) == 0).

Note: The scale of the BigDecimal is ignored. If you want to compare the values and the scales, use isEqualTo(Object).

isEqualTo

public void isEqualTo(@Nullable Object expected)

Checks that the actual value (including scale) is equal to the given BigDecimal.

Note: If you only want to compare the values of the BigDecimals and not their scales, use isEqualToIgnoringScale(BigDecimal) instead.

Overrides:

isEqualTo in class Subject

isEquivalentAccordingToCompareTo

public void isEquivalentAccordingToCompareTo(@Nullable BigDecimal expected)

Checks that the actual value is equivalent to the given value according to Comparable.compareTo(T), (i.e., checks that a.compareTo(b) == 0). This method behaves identically to (the more clearly named) isEqualToIgnoringScale(BigDecimal).

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

Overrides:

isEquivalentAccordingToCompareTo in class ComparableSubject<BigDecimal>