doc / ch.tutteli.atrium.api.cc.en_GB / isEqualIncludingScale

isEqualIncludingScale

fun <T : BigDecimal> Assert<T>.isEqualIncludingScale(expected: T): AssertionPlant<T> (source)
Deprecated: Switch from Assert to Expect; will be removed with 1.0.0 -- see https://github.com/robstoll/atrium/releases/tag/v0.9.0#migration for migration hints and scripts.

Makes the assertion that the Assert.subject is equal to expected including BigDecimal.scale.

Most of the time you want to use isNumericallyEqualTo which does not compare BigDecimal.scale in contrast to this function. Following the two functions compared:

assert(BigDecimal("10")).isEqualIncludingScale(BigDecimal("10.0")) does not hold.
assert(BigDecimal("10")).isNumericallyEqualTo(BigDecimal("10.0")) holds.

Exceptions

AssertionError - Might throw an AssertionError if the assertion made is not correct.

Return
This plant to support a fluent API.