org.assertj.core.api

Class AbstractBigIntegerAssert<SELF extends AbstractBigIntegerAssert<SELF>>

java.lang.Object

org.assertj.core.api.AbstractAssert<SELF,ACTUAL>

org.assertj.core.api.AbstractObjectAssert<SELF,ACTUAL>

org.assertj.core.api.AbstractComparableAssert<SELF,BigInteger>

org.assertj.core.api.AbstractBigIntegerAssert<SELF>

All Implemented Interfaces:

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

Direct Known Subclasses:

BigIntegerAssert

public class AbstractBigIntegerAssert<SELF extends AbstractBigIntegerAssert<SELF>>
extends AbstractComparableAssert<SELF,BigInteger>
implements NumberAssert<SELF,BigInteger>

Base class for all implementations of assertions for BigIntegers.

Since:

2.7.0 / 3.7.0

Field Summary

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

actual, info, myself, throwUnsupportedExceptionOnEquals

Constructor Summary

Constructors

Constructor and Description
AbstractBigIntegerAssert(BigInteger actual, Class<?> selfType)

Method Summary

Modifier and Type	Method and Description
SELF	isBetween(BigInteger start, BigInteger end) Verifies that the actual value is in [start, end] range (start and end included).
SELF	isCloseTo(BigInteger expected, Offset<BigInteger> offset) Verifies that the actual number is close to the given one within the given offset.
SELF	isCloseTo(BigInteger 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	isEqualTo(int expected) Same as isEqualTo(BigInteger) but takes care of converting given int to BigInteger for you.
SELF	isEqualTo(long expected) Same as isEqualTo(BigInteger) but takes care of converting given int to BigInteger for you.
SELF	isEqualTo(String expected) Same as isEqualTo(BigInteger) but takes care of converting given String to BigInteger for you.
SELF	isNegative() Verifies that the actual value is negative.
SELF	isNotCloseTo(BigInteger expected, Offset<BigInteger> offset) Verifies that the actual number is not close to the given one by less than the given offset.
SELF	isNotCloseTo(BigInteger 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	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(BigInteger start, BigInteger 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 BigInteger> customComparator) Use the given custom comparator instead of relying on actual type A equals method for incoming assertion checks.
SELF	usingComparator(Comparator<? super BigInteger> customComparator, String customComparatorDescription) Use the given custom comparator instead of relying on actual type A equals method for incoming assertion checks.
SELF	usingDefaultComparator() Revert to standard comparison for the 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, extracting, extracting, extracting, getComparatorsByType, hasAllNullFieldsOrProperties, hasAllNullFieldsOrPropertiesExcept, hasFieldOrProperty, hasFieldOrPropertyWithValue, hasNoNullFieldsOrProperties, hasNoNullFieldsOrPropertiesExcept, isEqualToComparingFieldByField, isEqualToComparingFieldByFieldRecursively, isEqualToComparingOnlyGivenFields, isEqualToIgnoringGivenFields, isEqualToIgnoringNullFields, newObjectAssert, returns, usingComparatorForFields, usingComparatorForType, usingRecursiveComparison, usingRecursiveComparison

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

asList, asString, describedAs, describedAs, descriptionText, doesNotHave, doesNotHaveSameClassAs, equals, failWithMessage, getWritableAssertionInfo, has, hashCode, hasSameClassAs, hasSameHashCodeAs, hasToString, is, isEqualTo, isExactlyInstanceOf, isIn, isIn, isInstanceOf, isInstanceOfAny, isInstanceOfSatisfying, isNot, isNotEqualTo, isNotExactlyInstanceOf, isNotIn, isNotIn, isNotInstanceOf, isNotInstanceOfAny, isNotNull, isNotOfAnyClassIn, isNotSameAs, isNull, isOfAnyClassIn, isSameAs, matches, matches, newListAssertInstance, overridingErrorMessage, satisfies, satisfies, satisfiesAnyOf, satisfiesAnyOf, setCustomRepresentation, throwAssertionError, withFailMessage, withRepresentation, withThreadDumpOnError

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractBigIntegerAssert

public AbstractBigIntegerAssert(BigInteger actual,
                                Class<?> selfType)

Method Detail

isZero

public SELF isZero()

Verifies that the actual value is equal to zero.

Example:

 // assertion will pass
 assertThat(BigInteger.ZERO).isZero();

 // assertion will fail
 assertThat(new BigInteger("8")).isZero();

Specified by:

isZero in interface NumberAssert<SELF extends AbstractBigIntegerAssert<SELF>,BigInteger>

Returns:

this assertion object.

Since:

2.7.0 / 3.7.0

isNotZero

public SELF isNotZero()

Verifies that the actual value is not equal to zero.

Example:

 // assertion will pass
 assertThat(new BigInteger("8")).isNotZero();

 // assertion will fail
 assertThat(BigInteger.ZERO).isNotZero();

Specified by:

isNotZero in interface NumberAssert<SELF extends AbstractBigIntegerAssert<SELF>,BigInteger>

Returns:

this assertion object.

Since:

2.7.0 / 3.7.0

isOne

public SELF isOne()

Verifies that the actual value is equal to one.

Example:

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

 // assertion will fail
 assertThat(new BigInteger("8")).isOne();

Specified by:

isOne in interface NumberAssert<SELF extends AbstractBigIntegerAssert<SELF>,BigInteger>

Returns:

this assertion object.

Since:

2.7.0 / 3.7.0

isPositive

public SELF isPositive()

Verifies that the actual value is positive.

Example:

 // assertion will pass
 assertThat(new BigInteger("8")).isPositive();

 // assertion will fail
 assertThat(new BigInteger("-8")).isPositive();

Specified by:

isPositive in interface NumberAssert<SELF extends AbstractBigIntegerAssert<SELF>,BigInteger>

Returns:

this assertion object.

Since:

2.7.0 / 3.7.0

isNegative

public SELF isNegative()

Verifies that the actual value is negative.

Example:

 // assertion will pass
 assertThat(new BigInteger("-8")).isNegative();

 // assertion will fail
 assertThat(new BigInteger("8")).isNegative();

Specified by:

isNegative in interface NumberAssert<SELF extends AbstractBigIntegerAssert<SELF>,BigInteger>

Returns:

this assertion object.

Since:

2.7.0 / 3.7.0

isNotNegative

public SELF isNotNegative()

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

Example:

 // assertion will pass
 assertThat(new BigInteger("8")).isNotNegative();

 // assertion will fail
 assertThat(new BigInteger("-8")).isNotNegative();

Specified by:

isNotNegative in interface NumberAssert<SELF extends AbstractBigIntegerAssert<SELF>,BigInteger>

Returns:

this assertion object.

Since:

2.7.0 / 3.7.0

isNotPositive

public SELF isNotPositive()

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

Example:

 // assertion will pass
 assertThat(new BigInteger("-8")).isNotPositive();

 // assertion will fail
 assertThat(new BigInteger("8")).isNotPositive();

Specified by:

isNotPositive in interface NumberAssert<SELF extends AbstractBigIntegerAssert<SELF>,BigInteger>

Returns:

this assertion object.

Since:

2.7.0 / 3.7.0

isCloseTo

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

Verifies that the actual number is close to the given one within the given offset.

When abs(actual - expected) == offset value, the assertion:

• succeeds when using Assertions.within(BigInteger)
• fails when using Assertions.byLessThan(BigInteger) or Offset.strictOffset(Number)

Breaking change since 2.9.0/3.9.0: using Assertions.byLessThan(BigInteger) implies a strict comparison, use Assertions.within(BigInteger) to get the old behavior.

Example:

 import static org.assertj.core.api.Assertions.within;
  
 final BigInteger eight = new BigInteger("8");
 final BigInteger ten =  BigInteger.TEN;

 // valid assertion
 assertThat(eight).isCloseTo(ten, within(new BigInteger("3")));
 assertThat(eight).isCloseTo(ten, byLessThan(new BigInteger("3")));

 // if difference is exactly equals to given offset value, it's ok
 assertThat(eight).isCloseTo(ten, within(new BigInteger("2")));
 // ... but not with byLessThan which implies a strict comparison
 assertThat(eight).isCloseTo(ten, byLessThan(new BigInteger("2")));

 // assertions will fail:
 assertThat(eight).isCloseTo(ten, within(BigInteger.ONE));
 assertThat(eight).isCloseTo(ten, byLessThan(BigInteger.ONE));

Specified by:

isCloseTo in interface NumberAssert<SELF extends AbstractBigIntegerAssert<SELF>,BigInteger>

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.

Since:

2.7.0 / 3.7.0

isNotCloseTo

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

Verifies that the actual number is not close to the given one by less than the given offset.

When abs(actual - expected) == offset value, the assertion:

• succeeds when using Assertions.byLessThan(BigInteger) or Offset.strictOffset(Number)
• fails when using Assertions.within(BigInteger)

Breaking change since 2.9.0/3.9.0: using Assertions.byLessThan(BigInteger) implies a strict comparison, use Assertions.within(BigInteger) to get the old behavior.

Examples:

 import static org.assertj.core.api.Assertions.byLessThan;
  
 final BigInteger eight = new BigInteger("8");
 final BigInteger ten =  BigInteger.TEN;

 // this assertion succeeds
 assertThat(eight).isNotCloseTo(ten, byLessThan(BigInteger.ONE));
 assertThat(eight).isNotCloseTo(ten, within(BigInteger.ONE));

 // diff == offset but isNotCloseTo succeeds as we use byLessThan
 assertThat(eight).isNotCloseTo(ten, byLessThan(new BigInteger("2")));

 // the assertion fails as the difference is equal to the offset value and we use 'within'
 assertThat(eight).isNotCloseTo(ten, within(new BigInteger("2")));
 // the assertion fails if the difference is greater than the given offset value
 assertThat(eight).isNotCloseTo(ten, within(new BigInteger("3")));
 assertThat(eight).isNotCloseTo(ten, byLessThan(new BigInteger("3")));

Specified by:

isNotCloseTo in interface NumberAssert<SELF extends AbstractBigIntegerAssert<SELF>,BigInteger>

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.7.0 / 3.7.0

See Also:

Assertions.byLessThan(BigInteger)

isCloseTo

public SELF isCloseTo(BigInteger 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 BigInteger:

 import static org.assertj.core.api.Assertions.withinPercentage; 
 
 // assertions will pass:
 assertThat(new BigInteger("11")).isCloseTo(BigInteger.TEN, withinPercentage(20));

 // if difference is exactly equals to the computed offset (1), it's ok
 assertThat(new BigInteger("11")).isCloseTo(BigInteger.TEN, withinPercentage(10));

 // assertion will fail
 assertThat(new BigInteger("11")).isCloseTo(BigInteger.TEN, withinPercentage(5));

Specified by:

isCloseTo in interface NumberAssert<SELF extends AbstractBigIntegerAssert<SELF>,BigInteger>

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.

Since:

2.7.0 / 3.7.0

isNotCloseTo

public SELF isNotCloseTo(BigInteger 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 BigInteger:

 import static org.assertj.core.api.Assertions.withinPercentage; 
 
 BigInteger eleven = new BigInteger("11");

 // assertion will pass:
 assertThat(eleven).isNotCloseTo(BigInteger.TEN, withinPercentage(5));

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

 // assertion will fail
 assertThat(eleven).isNotCloseTo(BigInteger.TEN, withinPercentage(20));

Specified by:

isNotCloseTo in interface NumberAssert<SELF extends AbstractBigIntegerAssert<SELF>,BigInteger>

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.

Since:

2.7.0 / 3.7.0

isBetween

public SELF isBetween(BigInteger start,
                      BigInteger end)

Verifies that the actual value is in [start, end] range (start and end included).

Example:

 // assertions will pass
 assertThat(new BigInteger("8")).isBetween(new BigInteger("7"), new BigInteger("9"));
 assertThat(new BigInteger("8")).isBetween(new BigInteger("8"), new BigInteger("9"));
 assertThat(new BigInteger("8")).isBetween(new BigInteger("7"), new BigInteger("8"));

 // assertion will fail
 assertThat(new BigInteger("8")).isBetween(new BigInteger("6"), new BigInteger("7"));

Specified by:

isBetween in interface ComparableAssert<SELF extends AbstractBigIntegerAssert<SELF>,BigInteger>

Specified by:

isBetween in interface NumberAssert<SELF extends AbstractBigIntegerAssert<SELF>,BigInteger>

Overrides:

isBetween in class AbstractComparableAssert<SELF extends AbstractBigIntegerAssert<SELF>,BigInteger>

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.

Since:

2.7.0 / 3.7.0

isStrictlyBetween

public SELF isStrictlyBetween(BigInteger start,
                              BigInteger end)

Verifies that the actual value is in ]start, end[ range (start excluded, end excluded).

Example:

 // assertion will pass
 assertThat(new BigInteger("8")).isStrictlyBetween(new BigInteger("7"), new BigInteger("9"));

 // assertions will fail
 assertThat(new BigInteger("8")).isStrictlyBetween(new BigInteger("8"), new BigInteger("9"));
 assertThat(new BigInteger("8")).isStrictlyBetween(new BigInteger("7"), new BigInteger("8"));

Specified by:

isStrictlyBetween in interface ComparableAssert<SELF extends AbstractBigIntegerAssert<SELF>,BigInteger>

Specified by:

isStrictlyBetween in interface NumberAssert<SELF extends AbstractBigIntegerAssert<SELF>,BigInteger>

Overrides:

isStrictlyBetween in class AbstractComparableAssert<SELF extends AbstractBigIntegerAssert<SELF>,BigInteger>

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.

Since:

2.7.0 / 3.7.0

isEqualTo

public SELF isEqualTo(String expected)

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

Example:

 // assertion will pass
 assertThat(new BigInteger("8")).isEqualTo("8");

 // assertion will fail
 assertThat(new BigInteger("8")).isEqualTo("2");

Parameters:

expected - the given number to compare the actual value to.

Returns:

this assertion object.

Since:

2.7.0 / 3.7.0

isEqualTo

public SELF isEqualTo(int expected)

Same as isEqualTo(BigInteger) but takes care of converting given int to BigInteger for you.

Example:

 // assertion will pass
 assertThat(new BigInteger("8")).isEqualTo(8);

 // assertion will fail
 assertThat(new BigInteger("8")).isEqualTo(2);

Parameters:

expected - the expected value

Returns:

this assertion object.

Since:

2.7.0 / 3.7.0

isEqualTo

public SELF isEqualTo(long expected)

Same as isEqualTo(BigInteger) but takes care of converting given int to BigInteger for you.

Example:

 // assertion will pass
 assertThat(new BigInteger("8")).isEqualTo(8L);

 // assertion will fail
 assertThat(new BigInteger("8")).isEqualTo(2L);

Parameters:

expected - the expected value

Returns:

this assertion object.

Since:

2.7.0 / 3.7.0

usingComparator

public SELF usingComparator(Comparator<? super BigInteger> customComparator)

Description copied from class: AbstractAssert

Use the given custom comparator instead of relying on actual type A equals method for incoming assertion checks.

The custom comparator is bound to assertion instance, meaning that if a new assertion instance is created, the default comparison strategy will be used.

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 AbstractBigIntegerAssert<SELF>,BigInteger>

Overrides:

usingComparator in class AbstractComparableAssert<SELF extends AbstractBigIntegerAssert<SELF>,BigInteger>

Parameters:

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

Returns:

this assertion object.

usingComparator

public SELF usingComparator(Comparator<? super BigInteger> customComparator,
                            String customComparatorDescription)

Description copied from class: AbstractAssert

Use the given custom comparator instead of relying on actual type A equals method for incoming assertion checks.

The custom comparator is bound to assertion instance, meaning that if a new assertion instance is created, the default comparison strategy will be used.

Examples :

 // frodo and sam are instances of Character with Hobbit race (obviously :).
 // raceComparator implements Comparator<Character>
 assertThat(frodo).usingComparator(raceComparator, "Hobbit Race Comparator").isEqualTo(sam);

Specified by:

usingComparator in interface Assert<SELF extends AbstractBigIntegerAssert<SELF>,BigInteger>

Overrides:

usingComparator in class AbstractComparableAssert<SELF extends AbstractBigIntegerAssert<SELF>,BigInteger>

Parameters:

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

customComparatorDescription - comparator description to be used in assertion error messages

Returns:

this assertion object.

usingDefaultComparator

public SELF usingDefaultComparator()

Description copied from class: AbstractAssert

Revert to standard comparison for the incoming assertion checks.

This method should be used to disable a custom comparison strategy set by calling usingComparator.

Specified by:

usingDefaultComparator in interface Assert<SELF extends AbstractBigIntegerAssert<SELF>,BigInteger>

Overrides:

usingDefaultComparator in class AbstractComparableAssert<SELF extends AbstractBigIntegerAssert<SELF>,BigInteger>

Returns:

this assertion object.