Package org.hamcrest.number

Class BigDecimalCloseTo

java.lang.Object

org.hamcrest.BaseMatcher<BigDecimal>

org.hamcrest.TypeSafeMatcher<BigDecimal>

org.hamcrest.number.BigDecimalCloseTo

All Implemented Interfaces:

Matcher<BigDecimal>, SelfDescribing

public class BigDecimalCloseTo
extends TypeSafeMatcher<BigDecimal>

A matcher that checks a BigDecimal is close to an expected value.

Constructor Summary

Constructors

Constructor	Description
BigDecimalCloseTo(BigDecimal value, BigDecimal error)	Constructor, best called from closeTo(BigDecimal, BigDecimal).

Method Summary

Modifier and Type	Method	Description
static Matcher<BigDecimal>	closeTo(BigDecimal operand, 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(BigDecimal item, Description mismatchDescription)	Describe the mismatch.
void	describeTo(Description description)	Generates a description of the object.
boolean	matchesSafely(BigDecimal item)	Check if the item matches.

Methods inherited from class org.hamcrest.TypeSafeMatcher

describeMismatch, matches

Methods inherited from class org.hamcrest.BaseMatcher

_dont_implement_Matcher___instead_extend_BaseMatcher_, isNotNull, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

BigDecimalCloseTo

public BigDecimalCloseTo(BigDecimal value,
 BigDecimal error)

Constructor, best called from closeTo(BigDecimal, BigDecimal).

Parameters:

value - the expected value

error - the acceptable difference from the expected value

See Also:

• closeTo(BigDecimal, BigDecimal)

Method Details

matchesSafely

public boolean matchesSafely(BigDecimal item)

Description copied from class: TypeSafeMatcher

Check if the item matches. The item will already have been checked for the specific type and will never be null. Subclasses should implement this.

Specified by:

matchesSafely in class TypeSafeMatcher<BigDecimal>

Parameters:

item - the type safe item to match against.

Returns:

boolean true/false depending if item matches matcher.

describeMismatchSafely

public void describeMismatchSafely(BigDecimal item,
 Description mismatchDescription)

Description copied from class: TypeSafeMatcher

Describe the mismatch. The item will already have been checked for the specific type and will never be null. Subclasses should override this.

Overrides:

describeMismatchSafely in class TypeSafeMatcher<BigDecimal>

Parameters:

item - the type safe item to match against.

mismatchDescription - the mismatch description.

describeTo

public void describeTo(Description description)

Description copied from interface: SelfDescribing

Generates a description of the object. The description may be part of a description of a larger object of which this is just a component, so it should be worded appropriately.

Parameters:

description - The description to be built or appended to.

closeTo

public static Matcher<BigDecimal> closeTo(BigDecimal operand,
 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

Returns:

The matcher.