mockit

Class Invocation

java.lang.Object

mockit.Invocation

public class Invocation
extends Object

A context object representing the current invocation to a mocked method/constructor, to be passed as the first parameter of the corresponding delegate/mock method implementation.

With the Expectations API, this parameter can appear in delegate methods implemented in Delegate classes. With the Mockups API, it can appear in @Mock methods.

See Also:

getInvokedInstance(), getInvokedArguments(), getInvocationCount(), getInvocationIndex(), getMinInvocations(), getMaxInvocations(), proceed(Object...), Tutorial (expectations), Tutorial (mockups)

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Invocation(Object invokedInstance, Object[] invokedArguments, int invocationCount, int minInvocations, int maxInvocations) For internal use only.

Method Summary

Modifier and Type	Method and Description
int	getInvocationCount() Returns the current invocation count.
int	getInvocationIndex() Returns the index for the current invocation.
Object[]	getInvokedArguments() Returns the actual argument values passed in the invocation to the mocked method/constructor.
<T> T	getInvokedInstance() Returns the instance on which the current invocation was made, or null for a static method invocation.
<M extends Member> M	getInvokedMember() Returns the Method or Constructor object corresponding to the mocked method or constructor, respectively.
int	getMaxInvocations() Returns the current value of the maximum invocation count for the matching expectation or mock method (-1 indicates that it's unlimited).
int	getMinInvocations() Returns the current value of the minimum invocation count associated with the matching expectation or mock method.
<T> T	proceed(Object... replacementArguments) Allows execution to proceed into the real implementation of the mocked method/constructor.

Methods inherited from class java.lang.Object

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

Constructor Detail

Invocation

protected Invocation(@Nullable
                     Object invokedInstance,
                     @Nonnull
                     Object[] invokedArguments,
                     int invocationCount,
                     int minInvocations,
                     int maxInvocations)

For internal use only.

Method Detail

getInvocationCount

public final int getInvocationCount()

Returns the current invocation count. The first invocation starts at 1 (one).

getInvocationIndex

public final int getInvocationIndex()

Returns the index for the current invocation. The first invocation starts at 0 (zero). Note that this is equivalent to getInvocationCount() - 1.

getInvokedArguments

public final Object[] getInvokedArguments()

Returns the actual argument values passed in the invocation to the mocked method/constructor.

getInvokedInstance

public final <T> T getInvokedInstance()

Returns the instance on which the current invocation was made, or null for a static method invocation.

getInvokedMember

public final <M extends Member> M getInvokedMember()

Returns the Method or Constructor object corresponding to the mocked method or constructor, respectively.

getMaxInvocations

public final int getMaxInvocations()

Returns the current value of the maximum invocation count for the matching expectation or mock method (-1 indicates that it's unlimited).

For an expectation, this call will return the value specified through the times or maxTimes field, if that was the case; if not, the value will be -1 for a regular or non-strict expectation, or 1 for a strict one. For a @Mock method, it will return the value specified for the invocations or maxInvocations attribute, or -1 if none.

getMinInvocations

public final int getMinInvocations()

Returns the current value of the minimum invocation count associated with the matching expectation or mock method.

For an expectation, this call will return the value specified through the times or minTimes field, if that was the case; if not, the value will be 1 for a regular or strict expectation, or 0 for a non-strict one. For a @Mock method, it will return the value specified for the invocations or minInvocations attribute, or 0 if none.

proceed

public final <T> T proceed(Object... replacementArguments)

Allows execution to proceed into the real implementation of the mocked method/constructor.

In the case of a mocked method, the real implementation is executed with the argument values originally received or explicitly given as replacement. Whatever comes out of that call (either a return value or a thrown exception/error, even if it is a checked exception) becomes the result of the current invocation to the mock method.

In the case of a mocked constructor, the real constructor implementation code which comes after the necessary call to "super" is executed, using the original argument values; replacement arguments are not supported. If the execution of said code throws an exception or error, it is propagated out to the caller of the mocked constructor (even in the case of a checked exception). Contrary to proceeding into a mocked method, it's not possible to actually execute test code inside the delegate method after proceeding into the real constructor, nor to proceed into it more than once.

Type Parameters:

T - the return type of the mocked method

Parameters:

replacementArguments - the argument values to be passed to the real method, as replacement for the values received by the mock method; if those received values should be passed without replacement, then this method should be called with no values

Returns:

the same value returned by the real method, if any

Throws:

UnsupportedOperationException - if attempting to proceed into a mocked method which does not belong to an injectable mocked type nor to a dynamic partially mocked type, into a native method, or into a mocked constructor while passing replacement arguments

See Also:

Tutorial