Package org.hamcrest.core

Class IsEqual<T>

  • All Implemented Interfaces:
    Matcher<T>, SelfDescribing
    public class IsEqual<T>
extends BaseMatcher<T>
    Is the value equal to another value, as tested by the Object.equals(java.lang.Object) invokedMethod?

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.lang.Object expectedValue  

    • Constructor Summary

      Constructors 
      Constructor Description
      IsEqual​(T equalArg)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      private static boolean areArrayElementsEqual​(java.lang.Object actualArray, java.lang.Object expectedArray)  
      private static boolean areArrayLengthsEqual​(java.lang.Object actualArray, java.lang.Object expectedArray)  
      private static boolean areArraysEqual​(java.lang.Object actualArray, java.lang.Object expectedArray)  
      private static boolean areEqual​(java.lang.Object actual, java.lang.Object expected)  
      void describeTo​(Description description)
      Generates a description of the object.
      static <T> Matcher<T> equalTo​(T operand)
      Creates a matcher that matches when the examined object is logically equal to the specified operand, as determined by calling the Object.equals(java.lang.Object) method on the examined object.
      static Matcher<java.lang.Object> equalToObject​(java.lang.Object operand)
      Creates an IsEqual matcher that does not enforce the values being compared to be of the same static type.
      private static boolean isArray​(java.lang.Object o)  
      boolean matches​(java.lang.Object actualValue)
      Evaluates the matcher for argument item.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • expectedValue

        private final java.lang.Object expectedValue

    • Constructor Detail

      • IsEqual

        public IsEqual​(T equalArg)

    • Method Detail

      • matches

        public boolean matches​(java.lang.Object actualValue)
        Description copied from interface: Matcher
        Evaluates the matcher for argument item. This method matches against Object, instead of the generic type T. This is because the caller of the Matcher does not know at runtime what the type is (because of type erasure with Java generics). It is down to the implementations to check the correct type.
        Parameters:
        actualValue - the object against which the matcher is evaluated.
        Returns:
        true if item matches, otherwise false.
        See Also:
        BaseMatcher

      • describeTo

        public void describeTo​(Description description)
        Description copied from interface: SelfDescribing
        Generates a description of the object. The description may be part of a 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.

      • areEqual

        private static boolean areEqual​(java.lang.Object actual,
                                java.lang.Object expected)

      • areArraysEqual

        private static boolean areArraysEqual​(java.lang.Object actualArray,
                                      java.lang.Object expectedArray)

      • areArrayLengthsEqual

        private static boolean areArrayLengthsEqual​(java.lang.Object actualArray,
                                            java.lang.Object expectedArray)

      • areArrayElementsEqual

        private static boolean areArrayElementsEqual​(java.lang.Object actualArray,
                                             java.lang.Object expectedArray)

      • isArray

        private static boolean isArray​(java.lang.Object o)

      • equalTo

        public static <T> Matcher<T> equalTo​(T operand)
        Creates a matcher that matches when the examined object is logically equal to the specified operand, as determined by calling the Object.equals(java.lang.Object) method on the examined object.

        If the specified operand is null then the created matcher will only match if the examined object's equals method returns true when passed a null (which would be a violation of the equals contract), unless the examined object itself is null, in which case the matcher will return a positive match.

        The created matcher provides a special behaviour when examining Arrays, whereby it will match if both the operand and the examined object are arrays of the same length and contain items that are equal to each other (according to the above rules) in the same indexes.

        For example: 
         assertThat("foo", equalTo("foo"));
 assertThat(new String[] {"foo", "bar"}, equalTo(new String[] {"foo", "bar"}));

      • equalToObject

        public static Matcher<java.lang.Object> equalToObject​(java.lang.Object operand)
        Creates an IsEqual matcher that does not enforce the values being compared to be of the same static type.