org.fest.assertions.api
Class BigDecimalAssert

java.lang.Object
  extended by org.fest.assertions.api.AbstractAssert<S,A>
      extended by org.fest.assertions.api.AbstractComparableAssert<S,A>
          extended by org.fest.assertions.api.AbstractUnevenComparableAssert<BigDecimalAssert,BigDecimal>
              extended by org.fest.assertions.api.BigDecimalAssert
All Implemented Interfaces:
Assert<BigDecimalAssert,BigDecimal>, ComparableAssert<BigDecimalAssert,BigDecimal>, Descriptable<BigDecimalAssert>, ExtensionPoints<BigDecimalAssert,BigDecimal>, NumberAssert<BigDecimal>, UnevenComparableAssert<BigDecimalAssert,BigDecimal>

public class BigDecimalAssert
extends AbstractUnevenComparableAssert<BigDecimalAssert,BigDecimal>
implements NumberAssert<BigDecimal>

Assertion methods for BigDecimals.

To create an instance of this class, invoke Assertions.assertThat(BigDecimal).

Author:
David DIDIER, Ted M. Young, Yvonne Wang, Alex Ruiz, Joel Costigliola

Field Summary
 
Fields inherited from class org.fest.assertions.api.AbstractAssert
actual, myself
 
Constructor Summary
protected BigDecimalAssert(BigDecimal actual)
           
 
Method Summary
 BigDecimalAssert isNegative()
          Verifies that the actual value is negative.
 BigDecimalAssert isNotZero()
          Verifies that the actual value is not equal to zero.
 BigDecimalAssert isPositive()
          Verifies that the actual value is positive.
 BigDecimalAssert isZero()
          Verifies that the actual value is equal to zero.
 BigDecimalAssert usingComparator(Comparator<?> customComparator)
          Use given custom comparator instead of relying on actual type A equals method for incoming assertion checks.
 BigDecimalAssert usingDefaultComparator()
          Revert to standard comparison for incoming assertion checks.
 
Methods inherited from class org.fest.assertions.api.AbstractUnevenComparableAssert
isEqualByComparingTo, isNotEqualByComparingTo
 
Methods inherited from class org.fest.assertions.api.AbstractComparableAssert
isGreaterThan, isGreaterThanOrEqualTo, isLessThan, isLessThanOrEqualTo
 
Methods inherited from class org.fest.assertions.api.AbstractAssert
as, as, describedAs, describedAs, descriptionText, doesNotHave, equals, has, hashCode, is, isEqualTo, isIn, isIn, isNot, isNotEqualTo, isNotIn, isNotIn, isNotNull, isNotSameAs, isNull, isSameAs
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.fest.assertions.core.ComparableAssert
isGreaterThan, isGreaterThanOrEqualTo, isLessThan, isLessThanOrEqualTo
 

Constructor Detail

BigDecimalAssert

protected BigDecimalAssert(BigDecimal actual)
Method Detail

isZero

public BigDecimalAssert isZero()
Verifies that the actual value is equal to zero.

Specified by:
isZero in interface NumberAssert<BigDecimal>
Returns:
this assertion object.

isNotZero

public BigDecimalAssert isNotZero()
Verifies that the actual value is not equal to zero.

Specified by:
isNotZero in interface NumberAssert<BigDecimal>
Returns:
this assertion object.

isPositive

public BigDecimalAssert isPositive()
Verifies that the actual value is positive.

Specified by:
isPositive in interface NumberAssert<BigDecimal>
Returns:
this assertion object.

isNegative

public BigDecimalAssert isNegative()
Verifies that the actual value is negative.

Specified by:
isNegative in interface NumberAssert<BigDecimal>
Returns:
this assertion object.

usingComparator

public BigDecimalAssert usingComparator(Comparator<?> 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.

Example :
 // compares invoices by payee 
 assertThat(invoiceList).usingComparator(invoicePayeeComparator).isEqualTo(expectedInvoiceList).
 
 // compares invoices by date, doesNotHaveDuplicates and contains both use the given invoice date comparator
 assertThat(invoiceList).usingComparator(invoiceDateComparator).doesNotHaveDuplicates().contains(may2010Invoice)
 
 // as assertThat(invoiceList) creates a new assertion, it uses standard comparison strategy (Invoice's equal method) to compare invoiceList elements to lowestInvoice.                                                      
 assertThat(invoiceList).contains(lowestInvoice).
 
Custom comparator is not parameterized with actual type A (ie. Comparator<A>) because if it was, we could not write the following code :
 // frodo and sam are instances of Character (a Character having a Race)
 // raceComparator implements Comparator<Character> 
 // assertThat(frodo) returns an ObjectAssert and not a custom CharacterAssert implementing Assert<CharacterAssert, Character>  
 assertThat(frodo).usingComparator(raceComparator).isEqualTo(sam); // won't compile !
 
 The code does not compile because assertThat(frodo) returns an ObjectAssert, thus usingComparator expects a Comparator<Object> 
 and Comparator<Character> is not a Comparator<Object> as generics are not reified.
 
 Note that, it would have worked if assertThat(frodo) returned a CharacterAssert implementing Assert<CharacterAssert, Character>. 
 

Specified by:
usingComparator in interface Assert<BigDecimalAssert,BigDecimal>
Overrides:
usingComparator in class AbstractComparableAssert<BigDecimalAssert,BigDecimal>
Parameters:
customComparator - the comparator to use for incoming assertion checks.
Returns:
this assertion object.

usingDefaultComparator

public BigDecimalAssert 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<BigDecimalAssert,BigDecimal>
Overrides:
usingDefaultComparator in class AbstractComparableAssert<BigDecimalAssert,BigDecimal>
Returns:
this assertion object.


Copyright © 2007-2012 FEST (Fixtures for Easy Software Testing). All Rights Reserved.