Constructor Detail

• Invocation

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

  For internal use only.

Method Detail

• getInvokedInstance

  public final <T> T getInvokedInstance()

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

• getInvokedArguments

  public final Object[] getInvokedArguments()

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

• 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.

• 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 0 for a non-strict expectation and 1 for a strict expectation. For a @Mock method, it will return the value specified for the invocations or minInvocations attribute, or 0 if none.

• setMinInvocations

  public final void setMinInvocations(int minInvocations)

  Sets the current value of the minimum invocation count for the matching expectation or mock method.

  For an expectation, this call can be used to override the value set on the times or minTimes field. For a @Mock method, it would override the value specified in the invocations or minInvocations attribute.

• 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 non-strict expectation and 1 for a strict expectation. For a @Mock method, it will return the value specified for the invocations or maxInvocations attribute, or -1 if none.

• setMaxInvocations

  public final void setMaxInvocations(int maxInvocations)

  Sets the current value of the maximum invocation count for the matching expectation or mock method. The value of -1 implies no upper limit.

  For an expectation, this call can be used to override the value set on the times or maxTimes field. For a @Mock method, it would override the value specified in the invocations or maxInvocations attribute.

• 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