Package org.hamcrest.number

Class IsCloseTo

java.lang.Object
org.hamcrest.BaseMatcher<Double>
org.hamcrest.TypeSafeMatcher<Double>
org.hamcrest.number.IsCloseTo
All Implemented Interfaces:
Matcher<Double>, SelfDescribing
public class IsCloseTo extends TypeSafeMatcher<Double>
Is the value a number equal to a value within some range of acceptable error?

  • Constructor Details

    • IsCloseTo

      public IsCloseTo(double value, double error)
      Constructor, best called from closeTo(double, double).
      Parameters:
      value - the expected value
      error - the acceptable difference from the expected value

  • Method Details

    • matchesSafely

      public boolean matchesSafely(Double 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<Double>
      Parameters:
      item - the type safe item to match against.
      Returns:
      boolean true/false depending if item matches matcher.

    • describeMismatchSafely

      public void describeMismatchSafely(Double 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<Double>
      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<Double> closeTo(double operand, double error)
      Creates a matcher of Doubles that matches when an examined double is equal to the specified operand, within a range of +/- error. For example: 
      assertThat(1.03, is(closeTo(1.0, 0.03)))
      Parameters:
      operand - the expected value of matching doubles
      error - the delta (+/-) within which matches will be allowed
      Returns:
      The matcher.