Package org.mockito.internal.matchers

Class Equals

    • Field Summary

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

    • Constructor Summary

      Constructors 
      Constructor Description
      Equals​(java.lang.Object wanted)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      private java.lang.String describe​(java.lang.Object object)  
      boolean equals​(java.lang.Object o)  
      java.lang.Object getWanted()  
      int hashCode()  
      boolean matches​(java.lang.Object actual)
      Informs if this matcher accepts the given argument.
      java.lang.String toString()  
      java.lang.String toStringWithType​(java.lang.String className)  
      java.lang.Class<?> type()
      The type of the argument this matcher matches.
      boolean typeMatches​(java.lang.Object target)
      Checks if target target has matching type.

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    • Field Detail

      • wanted

        private final java.lang.Object wanted

    • Constructor Detail

      • Equals

        public Equals​(java.lang.Object wanted)

    • Method Detail

      • matches

        public boolean matches​(java.lang.Object actual)
        Description copied from interface: ArgumentMatcher
        Informs if this matcher accepts the given argument.

        The method should never assert if the argument doesn't match. It should only return false.

        See the example in the top level javadoc for ArgumentMatcher

        Specified by:
        matches in interface ArgumentMatcher<java.lang.Object>
        Parameters:
        actual - the argument
        Returns:
        true if this matcher accepts the given argument.

      • type

        public java.lang.Class<?> type()
        Description copied from interface: ArgumentMatcher
        The type of the argument this matcher matches.

        This method is used to differentiate between a matcher used to match a raw vararg array parameter from a matcher used to match a single value passed as a vararg parameter.

        Where the matcher:

        • is at the parameter index of a vararg parameter
        • is the last matcher passed
        • this method returns a type assignable to the vararg parameter's raw type, i.e. its array type.
        ...then the matcher is matched against the raw vararg parameter, rather than the first element of the raw parameter.

        For example: 

        
  // Given vararg method with signature:
  int someVarargMethod(String... args);

  // The following will match invocations with any number of parameters, i.e. any number of elements in the raw array.
  mock.someVarargMethod(isA(String[].class));

  // The following will match invocations with a single parameter, i.e. one string in the raw array.
  mock.someVarargMethod(isA(String.class));

  // The following will match invocations with two parameters, i.e. two strings in the raw array
  mock.someVarargMethod(isA(String.class), isA(String.class));

        Only matcher implementations that can conceptually match a raw vararg parameter should override this method.

        Specified by:
        type in interface ArgumentMatcher<java.lang.Object>
        Returns:
        the type this matcher handles. The default value of Void means the type is not known.

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • describe

        private java.lang.String describe​(java.lang.Object object)

      • getWanted

        public final java.lang.Object getWanted()
        Specified by:
        getWanted in interface ContainsExtraTypeInfo
        Returns:
        Returns the wanted argument

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toStringWithType

        public java.lang.String toStringWithType​(java.lang.String className)
        Specified by:
        toStringWithType in interface ContainsExtraTypeInfo
        Parameters:
        className - - name of the class to be printed in description Returns more verbose description of the object which include type information