org.mockito.internal.matchers

Class Contains

java.lang.Object

org.mockito.internal.matchers.Contains

All Implemented Interfaces:

Serializable, ArgumentMatcher<String>

public class Contains
extends Object
implements ArgumentMatcher<String>, Serializable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Contains(String substring)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	matches(Object actual) Informs if this matcher accepts the given argument.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Contains

public Contains(String substring)

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<String>

Parameters:

actual - the argument

Returns:

true if this matcher accepts the given argument.

toString

public String toString()

Overrides:

toString in class Object