Package org.assertj.core.api

Class AbstractBigDecimalAssert<SELF extends AbstractBigDecimalAssert<SELF>>

    • 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"));
 // comparison is performed without scale consideration:
 assertThat(new BigDecimal("8.0")).isBetween(new BigDecimal("8.0"), new BigDecimal("8.00"));
 
 // 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 unlike 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.

      • 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");
        Parameters:
        expected - the given number to compare the actual value to.
        Returns:
        this assertion object.

      • 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");
        Parameters:
        expected - the expected BigDecimal passed as a String
        Returns:
        this assertion object.

      • isNotEqualByComparingTo

        public SELF isNotEqualByComparingTo​(String notExpected)
        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");
        Parameters:
        notExpected - the BigDecimal value passed as a String not to expect.
        Returns:
        this assertion object.

      • usingComparator

        public SELF usingComparator​(Comparator<? super BigDecimal> 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 AbstractBigDecimalAssert<SELF>,​BigDecimal>
        Overrides:
        usingComparator in class AbstractComparableAssert<SELF extends AbstractBigDecimalAssert<SELF>,​BigDecimal>
        Parameters:
        customComparator - the comparator to use for the incoming assertion checks.
        Returns:
        this assertion object.

      • usingComparator

        public SELF usingComparator​(Comparator<? super BigDecimal> 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 AbstractBigDecimalAssert<SELF>,​BigDecimal>
        Overrides:
        usingComparator in class AbstractComparableAssert<SELF extends AbstractBigDecimalAssert<SELF>,​BigDecimal>
        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.

      • isCloseTo

        public SELF isCloseTo​(BigDecimal expected,
                      Offset<BigDecimal> offset)
        Verifies that the actual number is close to the given one within the given offset value.

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

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

        Examples: 

         final BigDecimal eightDotOne = new BigDecimal("8.1");
 final BigDecimal eight =  new BigDecimal("8.0");
 
 // assertions succeed
 assertThat(eightDotOne).isCloseTo(eight, within(new BigDecimal("0.2")));
 assertThat(eightDotOne).isCloseTo(eight, byLessThan(new BigDecimal("0.2"))); // strict

 // assertions succeed when the difference == offset value ...  
 assertThat(eightDotOne).isCloseTo(eight, within(new BigDecimal("0.1")));
 // ... except when using byLessThan which implies a strict comparison
 assertThat(eightDotOne).isCloseTo(eight, byLessThan(new BigDecimal("0.1"))); // strict => fail
 
 // this assertion also fails
 assertThat(eightDotOne).isCloseTo(eight, within(new BigDecimal("0.001")));
        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.

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