org.mockito.internal.invocation

Class InterceptedInvocation

java.lang.Object

org.mockito.internal.invocation.InterceptedInvocation

All Implemented Interfaces:

Serializable, VerificationAwareInvocation, DescribedInvocation, Invocation, InvocationOnMock

public class InterceptedInvocation
extends Object
implements Invocation, VerificationAwareInvocation

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static RealMethod	NO_OP

Constructor Summary

Constructors

Constructor and Description
InterceptedInvocation(MockReference<Object> mockRef, MockitoMethod mockitoMethod, Object[] arguments, RealMethod realMethod, Location location, int sequenceNumber)

Method Summary

Modifier and Type	Method and Description
Object	callRealMethod() calls real method
boolean	equals(Object o)
<T> T	getArgument(int index) Returns casted argument at the given index.
<T> T	getArgument(int index, Class<T> clazz) Returns casted argument at the given index.
Object[]	getArguments() Returns arguments passed to the method.
List<ArgumentMatcher>	getArgumentsAsMatchers() Wraps each argument using ArgumentMatchers.eq(Object) or AdditionalMatchers.aryEq(Object[]) Used internally for the purposes of human-readable invocation printing.
Location	getLocation() The place in the code where the invocation happened.
Method	getMethod() returns the method
Object	getMock() returns the mock object
MockitoMethod	getMockitoMethod() Deprecated. Not used by Mockito but by mockito-scala
MockReference<Object>	getMockRef() Deprecated. Not used by Mockito but by mockito-scala
Object[]	getRawArguments() Returns unprocessed arguments whereas InvocationOnMock.getArguments() returns arguments already processed (e.g.
Class<?>	getRawReturnType() Returns unprocessed arguments whereas InvocationOnMock.getArguments() returns arguments already processed (e.g.
RealMethod	getRealMethod() Deprecated. Not used by Mockito but by mockito-scala
int	getSequenceNumber()
int	hashCode()
void	ignoreForVerification() Configures this invocation to be ignored for verify-no-more-invocations or verification in order.
boolean	isIgnoredForVerification() Informs if the invocation participates in verify-no-more-invocations or verification in order.
boolean	isVerified()
void	markStubbed(StubInfo stubInfo) Marks this invocation as stubbed.
void	markVerified() Marks this invocation as verified so that it will not cause verification error at Mockito.verifyNoMoreInteractions(Object...)
StubInfo	stubInfo()
String	toString() Describes the invocation in the human friendly way.

Methods inherited from class java.lang.Object

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

Field Detail

NO_OP

public static final RealMethod NO_OP

Constructor Detail

InterceptedInvocation

public InterceptedInvocation(MockReference<Object> mockRef,
                             MockitoMethod mockitoMethod,
                             Object[] arguments,
                             RealMethod realMethod,
                             Location location,
                             int sequenceNumber)

Method Detail

isVerified

public boolean isVerified()

Specified by:

isVerified in interface VerificationAwareInvocation

Specified by:

isVerified in interface Invocation

Returns:

whether the invocation has been already verified. Needed for Mockito.verifyNoMoreInteractions(Object...)

getSequenceNumber

public int getSequenceNumber()

Specified by:

getSequenceNumber in interface Invocation

Returns:

the sequence number of the Invocation. Useful to determine the order of invocations. Used by verification in order.

getLocation

public Location getLocation()

Description copied from interface: DescribedInvocation

The place in the code where the invocation happened.

Specified by:

getLocation in interface DescribedInvocation

Specified by:

getLocation in interface Invocation

Returns:

the location in code of this invocation.

getRawArguments

public Object[] getRawArguments()

Description copied from interface: Invocation

Returns unprocessed arguments whereas InvocationOnMock.getArguments() returns arguments already processed (e.g. varargs expended, etc.).

Specified by:

getRawArguments in interface Invocation

Returns:

unprocessed arguments, exactly as provided to this invocation.

getRawReturnType

public Class<?> getRawReturnType()

Description copied from interface: Invocation

Returns unprocessed arguments whereas InvocationOnMock.getArguments() returns arguments already processed (e.g. varargs expended, etc.).

Specified by:

getRawReturnType in interface Invocation

Returns:

unprocessed arguments, exactly as provided to this invocation.

markVerified

public void markVerified()

Description copied from interface: Invocation

Marks this invocation as verified so that it will not cause verification error at Mockito.verifyNoMoreInteractions(Object...)

Specified by:

markVerified in interface Invocation

stubInfo

public StubInfo stubInfo()

Specified by:

stubInfo in interface Invocation

Returns:

the stubbing information for this invocation. May return null - this means the invocation was not stubbed.

markStubbed

public void markStubbed(StubInfo stubInfo)

Description copied from interface: Invocation

Marks this invocation as stubbed.

Specified by:

markStubbed in interface Invocation

Parameters:

stubInfo - the information about stubbing.

isIgnoredForVerification

public boolean isIgnoredForVerification()

Description copied from interface: Invocation

Informs if the invocation participates in verify-no-more-invocations or verification in order.

Specified by:

isIgnoredForVerification in interface Invocation

Returns:

whether this invocation should be ignored for the purposes of verify-no-more-invocations or verification in order.

ignoreForVerification

public void ignoreForVerification()

Description copied from interface: Invocation

Configures this invocation to be ignored for verify-no-more-invocations or verification in order. See also Invocation.isIgnoredForVerification()

Specified by:

ignoreForVerification in interface Invocation

getMock

public Object getMock()

Description copied from interface: InvocationOnMock

returns the mock object

Specified by:

getMock in interface InvocationOnMock

Returns:

mock object

getMethod

public Method getMethod()

Description copied from interface: InvocationOnMock

returns the method

Specified by:

getMethod in interface InvocationOnMock

Returns:

method

getArguments

public Object[] getArguments()

Description copied from interface: InvocationOnMock

Returns arguments passed to the method. Vararg are expanded in this array.

Specified by:

getArguments in interface InvocationOnMock

Returns:

arguments

getArgument

public <T> T getArgument(int index)

Description copied from interface: InvocationOnMock

Returns casted argument at the given index. Can lookup in expanded arguments form InvocationOnMock.getArguments(). This method is preferred over InvocationOnMock.getArgument(int, Class) for readability. Please read the documentation of InvocationOnMock.getArgument(int, Class) for an overview of situations when that method is preferred over this one.

Specified by:

getArgument in interface InvocationOnMock

Parameters:

index - argument index

Returns:

casted argument at the given index

getArgument

public <T> T getArgument(int index,
                         Class<T> clazz)

Description copied from interface: InvocationOnMock

Returns casted argument at the given index. This method is analogous to InvocationOnMock.getArgument(int), but is necessary to circumvent issues when dealing with generics. In general, InvocationOnMock.getArgument(int) is the appropriate function to use. This particular function is only necessary if you are doing one of the following things:

1. You want to directly invoke a method on the result of InvocationOnMock.getArgument(int).
2. You want to directly pass the result of the invocation into a function that accepts a generic parameter.

If you prefer to use InvocationOnMock.getArgument(int) instead, you can circumvent the compilation issues by storing the intermediate result into a local variable with the correct type.

Specified by:

getArgument in interface InvocationOnMock

Parameters:

index - argument index

clazz - class to cast the argument to

Returns:

casted argument at the given index

getArgumentsAsMatchers

public List<ArgumentMatcher> getArgumentsAsMatchers()

Description copied from interface: Invocation

Wraps each argument using ArgumentMatchers.eq(Object) or AdditionalMatchers.aryEq(Object[]) Used internally for the purposes of human-readable invocation printing.

Specified by:

getArgumentsAsMatchers in interface Invocation

Returns:

a list of ArgumentMatcher wrapping each of this invocation arguments

callRealMethod

public Object callRealMethod()
                      throws Throwable

Description copied from interface: InvocationOnMock

calls real method

Warning: depending on the real implementation it might throw exceptions

Specified by:

callRealMethod in interface InvocationOnMock

Returns:

whatever the real method returns / throws

Throws:

Throwable - in case real method throws

getMockRef

@Deprecated
public MockReference<Object> getMockRef()

Deprecated. Not used by Mockito but by mockito-scala

getMockitoMethod

@Deprecated
public MockitoMethod getMockitoMethod()

Deprecated. Not used by Mockito but by mockito-scala

getRealMethod

@Deprecated
public RealMethod getRealMethod()

Deprecated. Not used by Mockito but by mockito-scala

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

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.