org.mockito.internal.matchers

Class Equals

java.lang.Object

org.mockito.internal.matchers.Equals

All Implemented Interfaces:

Serializable, ArgumentMatcher<Object>, ContainsExtraTypeInfo

Direct Known Subclasses:

ArrayEquals

public class Equals
extends Object
implements ArgumentMatcher<Object>, ContainsExtraTypeInfo, Serializable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Equals(Object wanted)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
protected Object	getWanted()
int	hashCode()
boolean	matches(Object actual) Informs if this matcher accepts the given argument.
String	toString()
String	toStringWithType() Returns more verbose description of the object which include type information
boolean	typeMatches(Object target) Checks if target target has matching type.

Methods inherited from class java.lang.Object

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

Constructor Detail

Equals

public Equals(Object wanted)

Method Detail

matches

public boolean matches(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.

The argument is not using the generic type in order to force explicit casting in the implementation. This way it is easier to debug when incompatible arguments are passed to the matchers. You have to trust us on this one. If we used parametrized type then ClassCastException would be thrown in certain scenarios. For example:

   //test, method accepts Collection argument and ArgumentMatcher<List> is used
   when(mock.useCollection(someListMatcher())).thenDoNothing();

   //production code, yields confusing ClassCastException
   //although Set extends Collection but is not compatible with ArgumentMatcher<List>
   mock.useCollection(new HashSet());
 

See the example in the top level javadoc for ArgumentMatcher

Specified by:

matches in interface ArgumentMatcher<Object>

Parameters:

actual - the argument

Returns:

true if this matcher accepts the given argument.

toString

public String toString()

Overrides:

toString in class Object

getWanted

protected final Object getWanted()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toStringWithType

public String toStringWithType()

Description copied from interface: ContainsExtraTypeInfo

Returns more verbose description of the object which include type information

Specified by:

toStringWithType in interface ContainsExtraTypeInfo

typeMatches

public boolean typeMatches(Object target)

Description copied from interface: ContainsExtraTypeInfo

Checks if target target has matching type. If the type matches, there is no point in rendering result from ContainsExtraTypeInfo.toStringWithType()

Specified by:

typeMatches in interface ContainsExtraTypeInfo