org.mockito.invocation.InvocationOnMock Maven / Gradle / Ivy
/*
* Copyright (c) 2007 Mockito contributors
* This program is made available under the terms of the MIT License.
*/
package org.mockito.invocation;
import java.io.Serializable;
import java.lang.reflect.Method;
/**
* An invocation on a mock
*
* A placeholder for mock, the method that was called and the arguments that were passed.
*/
public interface InvocationOnMock extends Serializable {
/**
* returns the mock object
*
* @return mock object
*/
Object getMock();
/**
* returns the method
*
* @return method
*/
Method getMethod();
/**
* returns arguments passed to the method
*
* @return arguments
*/
Object[] getArguments();
/**
* Returns casted argument using position
* @param index argument position
* @param clazz argument type
* @return casted argument on position
* @deprecated use {@link #getArgument(int)}
*/
@Deprecated
T getArgumentAt(int index, Class clazz);
/**
* Returns casted argument at the given index
* @param index argument index
* @return casted argument at the given index
*/
T getArgument(int index);
/**
* calls real method
*
* Warning: depending on the real implementation it might throw exceptions
*
* @return whatever the real method returns / throws
* @throws Throwable in case real method throws
*/
Object callRealMethod() throws Throwable;
}