AbstractBigDecimalAssert (AssertJ fluent assertions 2.7.0 API)

java.lang.Object
- org.assertj.core.api.AbstractAssert<SELF,ACTUAL>
- - org.assertj.core.api.AbstractObjectAssert<SELF,ACTUAL>
  - - org.assertj.core.api.AbstractComparableAssert<SELF,BigDecimal>
    - - org.assertj.core.api.AbstractBigDecimalAssert<SELF>

Type Parameters:
SELF - the "self" type of this assertion class. Please read "Emulating 'self types' using Java Generics to simplify fluent API implementation" for more details.

All Implemented Interfaces:

Assert<SELF,BigDecimal>, ComparableAssert<SELF,BigDecimal>, Descriptable<SELF>, ExtensionPoints<SELF,BigDecimal>, NumberAssert<SELF,BigDecimal>

Direct Known Subclasses:

BigDecimalAssert
```
public abstract class AbstractBigDecimalAssert<SELF extends AbstractBigDecimalAssert<SELF>>
extends AbstractComparableAssert<SELF,BigDecimal>
implements NumberAssert<SELF,BigDecimal>
```
Base class for all implementations of assertions for BigDecimals.

Author:

Drummond Dawson, David DIDIER, Ted M. Young, Yvonne Wang, Alex Ruiz, Joel Costigliola, Mikhail Mazursky

Field Summary
- Fields inherited from class org.assertj.core.api.AbstractAssert
  actual, info, myself

Constructor Summary

Constructors
Constructor and Description

AbstractBigDecimalAssert(BigDecimal actual, Class<?> selfType)

Constructors
Constructor and Description
`AbstractBigDecimalAssert(BigDecimal actual, Class<?> selfType)`

Method Summary

Methods
Modifier and Type	Method and Description
`SELF`	`isBetween(BigDecimal start, BigDecimal end)` Verifies that the actual value is in [start, end] range (start and end included).
`SELF`	`isCloseTo(BigDecimal expected, Offset<BigDecimal> offset)` Verifies that the actual number is close to the given one within the given offset. If difference is equal to offset value, assertion is considered valid.
`SELF`	`isCloseTo(BigDecimal expected, Percentage percentage)` Verifies that the actual number is close to the given one within the given percentage. If difference is equal to the percentage value, assertion is considered valid.
`SELF`	`isEqualByComparingTo(String expected)` Same as `isEqualByComparingTo(BigDecimal)` but takes care of converting given String to `BigDecimal`.
`SELF`	`isEqualTo(String expected)` Same as `isEqualTo(BigDecimal)` but takes care of converting given String to `BigDecimal` for you.
`SELF`	`isNegative()` Verifies that the actual value is negative.
`SELF`	`isNotCloseTo(BigDecimal expected, Offset<BigDecimal> offset)` Verifies that the actual number is not close to the given one by less than the given offset. If the difference is equal to the offset value, the assertion fails.
`SELF`	`isNotCloseTo(BigDecimal expected, Percentage percentage)` Verifies that the actual number is not close to the given one by the given percentage. If difference is equal to the percentage value, the assertion fails.
`SELF`	`isNotEqualByComparingTo(String expected)` Same as `isNotEqualByComparingTo(BigDecimal)` but takes care of converting given String to `BigDecimal`.
`SELF`	`isNotNegative()` Verifies that the actual value is non negative (positive or equal zero).
`SELF`	`isNotPositive()` Verifies that the actual value is non positive (negative or equal zero).
`SELF`	`isNotZero()` Verifies that the actual value is not equal to zero.
`SELF`	`isOne()` Verifies that the actual value is equal to one.
`SELF`	`isPositive()` Verifies that the actual value is positive.
`SELF`	`isStrictlyBetween(BigDecimal start, BigDecimal end)` Verifies that the actual value is in ]start, end[ range (start excluded, end excluded).
`SELF`	`isZero()` Verifies that the actual value is equal to zero.
`SELF`	`usingComparator(Comparator<? super BigDecimal> customComparator)` Use given custom comparator instead of relying on actual type A equals method for incoming assertion checks.
`SELF`	`usingDefaultComparator()` Revert to standard comparison for incoming assertion checks.

Methods inherited from class org.assertj.core.api.AbstractComparableAssert
inBinary, inHexadecimal, isEqualByComparingTo, isGreaterThan, isGreaterThanOrEqualTo, isLessThan, isLessThanOrEqualTo, isNotEqualByComparingTo

Methods inherited from class org.assertj.core.api.AbstractObjectAssert
as, as, defaultTypeComparators, extracting, hasFieldOrProperty, hasFieldOrPropertyWithValue, hasNoNullFieldsOrProperties, hasNoNullFieldsOrPropertiesExcept, isEqualToComparingFieldByField, isEqualToComparingFieldByFieldRecursively, isEqualToComparingOnlyGivenFields, isEqualToIgnoringGivenFields, isEqualToIgnoringNullFields, usingComparatorForFields, usingComparatorForType

Methods inherited from class org.assertj.core.api.AbstractAssert
asList, asString, describedAs, describedAs, descriptionText, doesNotHave, doesNotHaveSameClassAs, equals, failWithMessage, getWritableAssertionInfo, has, hashCode, hasSameClassAs, hasToString, is, isEqualTo, isExactlyInstanceOf, isIn, isIn, isInstanceOf, isInstanceOfAny, isNot, isNotEqualTo, isNotExactlyInstanceOf, isNotIn, isNotIn, isNotInstanceOf, isNotInstanceOfAny, isNotNull, isNotOfAnyClassIn, isNotSameAs, isNull, isOfAnyClassIn, isSameAs, overridingErrorMessage, setCustomRepresentation, throwAssertionError, withFailMessage, withRepresentation, withThreadDumpOnError

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractBigDecimalAssert

public AbstractBigDecimalAssert(BigDecimal actual,
                        Class<?> selfType)

Method Detail

isZero

public SELF isZero()

Verifies that the actual value is equal to zero.

Example:

 // assertions will pass
 assertThat(0).isZero();
 assertThat(0.0).isZero();

 // assertions will fail
 assertThat(42).isZero();
 assertThat(3.142).isZero();

Example:

 // assertion will pass
 assertThat(BigDecimal.ZERO).isZero();
 
 // assertion will fail
 assertThat(new BigDecimal("8.00")).isZero();

Specified by:: isZero in interface NumberAssert<SELF extends AbstractBigDecimalAssert<SELF>,BigDecimal>
Returns:: this assertion object.

isNotZero

public SELF isNotZero()

Verifies that the actual value is not equal to zero.

Example:

 // assertions will pass
 assertThat(42).isNotZero();
 assertThat(3.142).isNotZero();

 // assertions will fail
 assertThat(0).isNotZero();
 assertThat(0.0).isNotZero();

Example:

 // assertion will pass
 assertThat(new BigDecimal("8.00")).isNotZero();
 
 // assertion will fail
 assertThat(BigDecimal.ZERO).isNotZero();

Specified by:: isNotZero in interface NumberAssert<SELF extends AbstractBigDecimalAssert<SELF>,BigDecimal>
Returns:: this assertion object.

isOne

public SELF isOne()

Verifies that the actual value is equal to one.

Example:

 // assertions will pass
 assertThat(1).isOne();
 assertThat(1.0).isOne();

 // assertions will fail
 assertThat(42).isOne();
 assertThat(3.142).isOne();

Example:

 // assertion will pass
 assertThat(BigDecimal.ONE).isOne();

 // assertion will fail
 assertThat(new BigDecimal("8.00")).isOne();

Specified by:: isOne in interface NumberAssert<SELF extends AbstractBigDecimalAssert<SELF>,BigDecimal>
Returns:: this assertion object.

isPositive

public SELF isPositive()

Verifies that the actual value is positive.

Example:

 // assertions will pass
 assertThat(42).isPositive();
 assertThat(3.142).isPositive();

 // assertions will fail
 assertThat(0).isPositive();
 assertThat(-42).isPositive();

Example:

 // assertion will pass
 assertThat(new BigDecimal("8.0")).isPositive();
 
 // assertion will fail
 assertThat(new BigDecimal("-8.0")).isPositive();

Specified by:: isPositive in interface NumberAssert<SELF extends AbstractBigDecimalAssert<SELF>,BigDecimal>
Returns:: this assertion object.

isNegative

public SELF isNegative()

Verifies that the actual value is negative.

Example:

 // assertions will pass
 assertThat(-42).isNegative();
 assertThat(-3.124).isNegative();

 // assertions will fail
 assertThat(0).isNegative();
 assertThat(42).isNegative();

Example:

 // assertion will pass
 assertThat(new BigDecimal("-8.0")).isNegative();
 
 // assertion will fail
 assertThat(new BigDecimal("8.0")).isNegative();

Specified by:: isNegative in interface NumberAssert<SELF extends AbstractBigDecimalAssert<SELF>,BigDecimal>
Returns:: this assertion object.

isNotPositive

public SELF isNotPositive()

Verifies that the actual value is non positive (negative or equal zero).

Example:

 // assertions will pass
 assertThat(-42).isNotPositive();
 assertThat(0).isNotPositive();

 // assertions will fail
 assertThat(42).isNotPositive();
 assertThat(3.124).isNotPositive();

Example:

 // assertion will pass
 assertThat(new BigDecimal("-8.0")).isNotPositive();
 
 // assertion will fail
 assertThat(new BigDecimal("8.0")).isNotPositive();

Specified by:: isNotPositive in interface NumberAssert<SELF extends AbstractBigDecimalAssert<SELF>,BigDecimal>
Returns:: this assertion object.

isNotNegative

public SELF isNotNegative()

Verifies that the actual value is non negative (positive or equal zero).

Example:

 // assertions will pass
 assertThat(42).isNotNegative();
 assertThat(0).isNotNegative();

 // assertions will fail
 assertThat(-42).isNotNegative();
 assertThat(-3.124).isNotNegative();

Example:

 // assertion will pass
 assertThat(new BigDecimal("8.0")).isNotNegative();
 
 // assertion will fail
 assertThat(new BigDecimal("-8.0")).isNotNegative();

Specified by:: isNotNegative in interface NumberAssert<SELF extends AbstractBigDecimalAssert<SELF>,BigDecimal>
Returns:: this assertion object.

isBetween
```
public SELF isBetween(BigDecimal start,
             BigDecimal end)
```
Verifies that the actual value is in [start, end] range (start and end included).
Example:
```
 // assertions will pass
 assertThat(new BigDecimal("8.0")).isBetween(new BigDecimal("7.0"), new BigDecimal("9.0"));
 assertThat(new BigDecimal("8.00")).isBetween(new BigDecimal("7.0"), new BigDecimal("9.0"));
 assertThat(new BigDecimal("8.0")).isBetween(new BigDecimal("8.0"), new BigDecimal("9.0"));
 assertThat(new BigDecimal("8.0")).isBetween(new BigDecimal("7.0"), new BigDecimal("8.0"));
 
 // assertion will fail
 assertThat(new BigDecimal("8.0")).isBetween(new BigDecimal("6.0"), new BigDecimal("7.0"));
```
Note that comparison of BigDecimal is done by value without scale consideration, i.e 2.0 and 2.00 are considered equal in value (not like BigDecimal.equals(Object).
Specified by:

isBetween in interface ComparableAssert<SELF extends AbstractBigDecimalAssert<SELF>,BigDecimal>

Specified by:

isBetween in interface NumberAssert<SELF extends AbstractBigDecimalAssert<SELF>,BigDecimal>

Overrides:

isBetween in class AbstractComparableAssert<SELF extends AbstractBigDecimalAssert<SELF>,BigDecimal>

Parameters:
start - the start value (inclusive), expected not to be null.
end - the end value (inclusive), expected not to be null.

Returns:
this assertion object.

isStrictlyBetween
```
public SELF isStrictlyBetween(BigDecimal start,
                     BigDecimal end)
```
Verifies that the actual value is in ]start, end[ range (start excluded, end excluded).
Example:
```
 // assertion will pass
 assertThat(new BigDecimal("8.0")).isStrictlyBetween(new BigDecimal("7.0"), new BigDecimal("9.0"));
 
 // assertions will fail
 assertThat(new BigDecimal("8.0")).isStrictlyBetween(new BigDecimal("8.0"), new BigDecimal("9.0"));
 assertThat(new BigDecimal("8.0")).isStrictlyBetween(new BigDecimal("7.0"), new BigDecimal("8.0"));
```
Specified by:

isStrictlyBetween in interface ComparableAssert<SELF extends AbstractBigDecimalAssert<SELF>,BigDecimal>

Specified by:

isStrictlyBetween in interface NumberAssert<SELF extends AbstractBigDecimalAssert<SELF>,BigDecimal>

Overrides:

isStrictlyBetween in class AbstractComparableAssert<SELF extends AbstractBigDecimalAssert<SELF>,BigDecimal>

Parameters:
start - the start value (exclusive), expected not to be null.
end - the end value (exclusive), expected not to be null.

Returns:
this assertion object.

isEqualTo

public SELF isEqualTo(String expected)

Same as isEqualTo(BigDecimal) but takes care of converting given String to BigDecimal for you.

Example:

 // assertion will pass
 assertThat(new BigDecimal("8.0")).isEqualTo("8.0");
 
 // assertion will fail because 8.00 is not equals to 8.0
 assertThat(new BigDecimal("8.00")).isEqualTo("8.0");

isEqualByComparingTo

public SELF isEqualByComparingTo(String expected)

Same as isEqualByComparingTo(BigDecimal) but takes care of converting given String to BigDecimal.

Example:

 // assertions will pass
 assertThat(new BigDecimal("8.0")).isEqualByComparingTo("8.0");
 // assertion will pass because 8.0 is equals to 8.00 using BigDecimal.compareTo(Object)
 assertThat(new BigDecimal("8.0")).isEqualByComparingTo("8.00");
 
 // assertion will fail
 assertThat(new BigDecimal("8.0")).isEqualByComparingTo("2.0");

isNotEqualByComparingTo

public SELF isNotEqualByComparingTo(String expected)

Same as isNotEqualByComparingTo(BigDecimal) but takes care of converting given String to BigDecimal.

Example:

 // assertions will pass
 assertThat(new BigDecimal("8.0")).isNotEqualByComparingTo("7.99");

 // assertion will fail
 assertThat(new BigDecimal("8.0")).isNotEqualByComparingTo("8.00");

usingComparator
```
public SELF usingComparator(Comparator<? super BigDecimal> customComparator)
```
Description copied from class: AbstractAssert
Use given custom comparator instead of relying on actual type A equals method for incoming assertion checks.
Custom comparator is bound to assertion instance, meaning that if a new assertion is created, it will use default comparison strategy. Examples :
```
 // frodo and sam are instances of Character with Hobbit race (obviously :).
 // raceComparator implements Comparator<Character> 
 assertThat(frodo).usingComparator(raceComparator).isEqualTo(sam);
```
Specified by:

usingComparator in interface Assert<SELF extends AbstractBigDecimalAssert<SELF>,BigDecimal>

Overrides:

usingComparator in class AbstractComparableAssert<SELF extends AbstractBigDecimalAssert<SELF>,BigDecimal>

Parameters:
customComparator - the comparator to use for incoming assertion checks.

Returns:
this assertion object.

usingDefaultComparator
```
public SELF usingDefaultComparator()
```
Description copied from class: AbstractAssert

Revert to standard comparison for incoming assertion checks.
This method should be used to disable a custom comparison strategy set by calling Assert.usingComparator(Comparator).

Specified by:

usingDefaultComparator in interface Assert<SELF extends AbstractBigDecimalAssert<SELF>,BigDecimal>

Overrides:

usingDefaultComparator in class AbstractComparableAssert<SELF extends AbstractBigDecimalAssert<SELF>,BigDecimal>

Returns:
this assertion object.

isCloseTo

public SELF isCloseTo(BigDecimal expected,
             Offset<BigDecimal> offset)

Verifies that the actual number is close to the given one within the given offset.
If difference is equal to offset value, assertion is considered valid.

Example:

 final BigDecimal actual = new BigDecimal("8.1");
 final BigDecimal other =  new BigDecimal("8.0");

 // valid assertion
 assertThat(actual).isCloseTo(other, within(new BigDecimal("0.2")));

 // if difference is exactly equals to given offset value, it's ok
 assertThat(actual).isCloseTo(other, within(new BigDecimal("0.1")));

 // BigDecimal format has no impact on the assertion, this assertion is valid:
 assertThat(actual).isCloseTo(new BigDecimal("8.00"), within(new BigDecimal("0.100")));

 // but if difference is greater than given offset value assertion will fail :
 assertThat(actual).isCloseTo(other, within(new BigDecimal("0.01")));

Specified by:: isCloseTo in interface NumberAssert<SELF extends AbstractBigDecimalAssert<SELF>,BigDecimal>
Parameters:: expected - the given number to compare the actual value to.; offset - the given positive offset.
Returns:: this assertion object.
Throws:: NullPointerException - if the given offset is null.; NullPointerException - if the expected number is null.; AssertionError - if the actual value is not close to the given one.

isNotCloseTo

public SELF isNotCloseTo(BigDecimal expected,
                Offset<BigDecimal> offset)

Verifies that the actual number is not close to the given one by less than the given offset.
If the difference is equal to the offset value, the assertion fails.

Example:

 final BigDecimal actual = new BigDecimal("8.1");
 final BigDecimal other =  new BigDecimal("8.0");

 // this assertion succeeds
 assertThat(actual).isNotCloseTo(other, byLessThan(new BigDecimal("0.01")));

 // BigDecimal format has no impact on the assertion, this assertion is valid:
 assertThat(actual).isNotCloseTo(new BigDecimal("8.00"), byLessThan(new BigDecimal("0.100")));

 // the assertion fails if the difference is equal to the given offset value 
 assertThat(actual).isNotCloseTo(other, byLessThan(new BigDecimal("0.1")));

 // the assertion fails if the difference is greater than the given offset value 
 assertThat(actual).isNotCloseTo(other, byLessThan(new BigDecimal("0.2")));

Specified by:: isNotCloseTo in interface NumberAssert<SELF extends AbstractBigDecimalAssert<SELF>,BigDecimal>
Parameters:: expected - the given number to compare the actual value to.; offset - the given positive offset.
Returns:: this assertion object.
Throws:: NullPointerException - if the given offset is null.; NullPointerException - if the expected number is null.; AssertionError - if the actual value is close to the given one within the offset value.
Since:: 2.6.0 / 3.6.0
See Also:: Assertions.byLessThan(BigDecimal)

isCloseTo
```
public SELF isCloseTo(BigDecimal expected,
             Percentage percentage)
```
Verifies that the actual number is close to the given one within the given percentage.
If difference is equal to the percentage value, assertion is considered valid.
Example with BigDecimal:
```
 // assertions will pass:
 assertThat(BigDecimal.valueOf(11.0)).isCloseTo(BigDecimal.TEN, withinPercentage(BigDecimal.valueOf(20d)));

 // if difference is exactly equals to the computed offset (1.0), it's ok
 assertThat(BigDecimal.valueOf(11.0)).isCloseTo(BigDecimal.TEN, withinPercentage(BigDecimal.valueOf(10d)));

 // assertion will fail
 assertThat(BigDecimal.valueOf(11.0)).isCloseTo(BigDecimal.TEN, withinPercentage(BigDecimal.valueOf(5d)));
```
Specified by:

isCloseTo in interface NumberAssert<SELF extends AbstractBigDecimalAssert<SELF>,BigDecimal>

Parameters:
expected - the given number to compare the actual value to.
percentage - the given positive percentage.

Returns:
this assertion object.

Throws:

NullPointerException - if the given offset is null.

NullPointerException - if the expected number is null.

AssertionError - if the actual value is not close to the given one.

isNotCloseTo
```
public SELF isNotCloseTo(BigDecimal expected,
                Percentage percentage)
```
Verifies that the actual number is not close to the given one by the given percentage.
If difference is equal to the percentage value, the assertion fails.
Example with BigDecimal:
```
 BigDecimal eleven = BigDecimal.valueOf(11.0);
  
 // assertion will pass:
 assertThat(eleven).isNotCloseTo(BigDecimal.TEN, withinPercentage(new BigDecimal("5")));

 // assertion will fail as the difference is exactly equals to the computed offset (1.0) 
 assertThat(eleven).isNotCloseTo(BigDecimal.TEN, withinPercentage(new BigDecimal("10")));

 // assertion will fail
 assertThat(eleven).isNotCloseTo(BigDecimal.TEN, withinPercentage(new BigDecimal("20")));
```
Specified by:

isNotCloseTo in interface NumberAssert<SELF extends AbstractBigDecimalAssert<SELF>,BigDecimal>

Parameters:
expected - the given number to compare the actual value to.
percentage - the given positive percentage.

Returns:
this assertion object.

Throws:

NullPointerException - if the given offset is null.

NullPointerException - if the expected number is null.

AssertionError - if the actual value is close to the given one.

Class AbstractBigDecimalAssert<SELF extends AbstractBigDecimalAssert<SELF>>

Field Summary

Fields inherited from class org.assertj.core.api.AbstractAssert

Constructor Summary

Method Summary

Methods inherited from class org.assertj.core.api.AbstractComparableAssert

Methods inherited from class org.assertj.core.api.AbstractObjectAssert

Methods inherited from class org.assertj.core.api.AbstractAssert

Methods inherited from class java.lang.Object

Constructor Detail

AbstractBigDecimalAssert

Method Detail

isZero

isNotZero

isOne

isPositive

isNegative

isNotPositive

isNotNegative

isBetween

isStrictlyBetween

isEqualTo

isEqualByComparingTo

isNotEqualByComparingTo

usingComparator

usingDefaultComparator

isCloseTo

isNotCloseTo

isCloseTo

isNotCloseTo