org.mockito.internal.invocation

Class InvocationMatcher

java.lang.Object

org.mockito.internal.invocation.InvocationMatcher

All Implemented Interfaces:

Serializable, DescribedInvocation, MatchableInvocation

Direct Known Subclasses:

StubbedInvocationMatcher

public class InvocationMatcher
extends Object
implements MatchableInvocation, DescribedInvocation, Serializable

In addition to all content of the invocation, the invocation matcher contains the argument matchers. Invocation matcher is used during verification and stubbing. In those cases, the user can provide argument matchers instead of 'raw' arguments. Raw arguments are converted to 'equals' matchers anyway.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
InvocationMatcher(Invocation invocation)
InvocationMatcher(Invocation invocation, List<ArgumentMatcher> matchers)

Method Summary

Modifier and Type	Method and Description
void	captureArgumentsFrom(Invocation invocation) This method is used by Mockito to implement argument captor functionality (see ArgumentCaptor.
static List<InvocationMatcher>	createFrom(List<Invocation> invocations)
Invocation	getInvocation() The actual invocation Mockito will match against.
Location	getLocation() The place in the code where the invocation happened.
List<ArgumentMatcher>	getMatchers() The argument matchers of this invocation.
Method	getMethod()
boolean	hasSameMethod(Invocation candidate) Returns true if the candidate invocation has the same method (method name and parameter types)
boolean	hasSimilarMethod(Invocation candidate) similar means the same method name, same mock, unverified and: if arguments are the same cannot be overloaded
boolean	matches(Invocation candidate) Same method, mock and all arguments match.
String	toString() Describes the invocation in the human friendly way.

Methods inherited from class java.lang.Object

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

Constructor Detail

InvocationMatcher

public InvocationMatcher(Invocation invocation,
                         List<ArgumentMatcher> matchers)

InvocationMatcher

public InvocationMatcher(Invocation invocation)

Method Detail

createFrom

public static List<InvocationMatcher> createFrom(List<Invocation> invocations)

getMethod

public Method getMethod()

getInvocation

public Invocation getInvocation()

Description copied from interface: MatchableInvocation

The actual invocation Mockito will match against.

Specified by:

getInvocation in interface MatchableInvocation

getMatchers

public List<ArgumentMatcher> getMatchers()

Description copied from interface: MatchableInvocation

The argument matchers of this invocation. When the invocation is declared without argument matchers (e.g. using plain arguments) Mockito still converts them into ArgumentMatcher instances that use 'eq' matching via ArgumentMatchers.eq(Object).

Specified by:

getMatchers in interface MatchableInvocation

toString

public String toString()

Description copied from interface: DescribedInvocation

Describes the invocation in the human friendly way.

Specified by:

toString in interface DescribedInvocation

Overrides:

toString in class Object

Returns:

the description of this invocation.

matches

public boolean matches(Invocation candidate)

Description copied from interface: MatchableInvocation

Same method, mock and all arguments match.

Specified by:

matches in interface MatchableInvocation

hasSimilarMethod

public boolean hasSimilarMethod(Invocation candidate)

similar means the same method name, same mock, unverified and: if arguments are the same cannot be overloaded

Specified by:

hasSimilarMethod in interface MatchableInvocation

hasSameMethod

public boolean hasSameMethod(Invocation candidate)

Description copied from interface: MatchableInvocation

Returns true if the candidate invocation has the same method (method name and parameter types)

Specified by:

hasSameMethod in interface MatchableInvocation

getLocation

public Location getLocation()

Description copied from interface: DescribedInvocation

The place in the code where the invocation happened.

Specified by:

getLocation in interface DescribedInvocation

Returns:

the location of the invocation.

captureArgumentsFrom

public void captureArgumentsFrom(Invocation invocation)

Description copied from interface: MatchableInvocation

This method is used by Mockito to implement argument captor functionality (see ArgumentCaptor.

Makes this instance of matchable invocation capture all arguments of provided invocation.

Specified by:

captureArgumentsFrom in interface MatchableInvocation

Parameters:

invocation - the invocation to capture the arguments from