org.hamcrest.number
Class BigDecimalCloseTo

java.lang.Object
  extended by org.hamcrest.BaseMatcher<T>
      extended by org.hamcrest.TypeSafeMatcher<java.math.BigDecimal>
          extended by org.hamcrest.number.BigDecimalCloseTo
All Implemented Interfaces:
org.hamcrest.Matcher<java.math.BigDecimal>, org.hamcrest.SelfDescribing

public class BigDecimalCloseTo
extends org.hamcrest.TypeSafeMatcher<java.math.BigDecimal>


Constructor Summary
BigDecimalCloseTo(java.math.BigDecimal value, java.math.BigDecimal error)
           
 
Method Summary
static org.hamcrest.Matcher<java.math.BigDecimal> closeTo(java.math.BigDecimal operand, java.math.BigDecimal error)
          Creates a matcher of BigDecimals that matches when an examined BigDecimal is equal to the specified operand, within a range of +/- error.
 void describeMismatchSafely(java.math.BigDecimal item, org.hamcrest.Description mismatchDescription)
           
 void describeTo(org.hamcrest.Description description)
           
 boolean matchesSafely(java.math.BigDecimal item)
           
 
Methods inherited from class org.hamcrest.TypeSafeMatcher
describeMismatch, matches
 
Methods inherited from class org.hamcrest.BaseMatcher
_dont_implement_Matcher___instead_extend_BaseMatcher_, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

BigDecimalCloseTo

public BigDecimalCloseTo(java.math.BigDecimal value,
                         java.math.BigDecimal error)
Method Detail

matchesSafely

public boolean matchesSafely(java.math.BigDecimal item)
Specified by:
matchesSafely in class org.hamcrest.TypeSafeMatcher<java.math.BigDecimal>

describeMismatchSafely

public void describeMismatchSafely(java.math.BigDecimal item,
                                   org.hamcrest.Description mismatchDescription)
Overrides:
describeMismatchSafely in class org.hamcrest.TypeSafeMatcher<java.math.BigDecimal>

describeTo

public void describeTo(org.hamcrest.Description description)

closeTo

public static org.hamcrest.Matcher<java.math.BigDecimal> closeTo(java.math.BigDecimal operand,
                                                                 java.math.BigDecimal error)
Creates a matcher of BigDecimals that matches when an examined BigDecimal is equal to the specified operand, within a range of +/- error. The comparison for equality is done by BigDecimals BigDecimal.compareTo(java.math.BigDecimal) method.

For example:

assertThat(new BigDecimal("1.03"), is(closeTo(new BigDecimal("1.0"), new BigDecimal("0.03"))))

Parameters:
operand - the expected value of matching BigDecimals
error - the delta (+/-) within which matches will be allowed