net.sf.kdgcommons.test

Class SelfMock<MockedType>

java.lang.Object

net.sf.kdgcommons.test.SelfMock<MockedType>

All Implemented Interfaces:

InvocationHandler

public abstract class SelfMock<MockedType>
extends Object
implements InvocationHandler

A reflection-based proxy that invokes requests on itself. This class is intended to be subclassed, with the subclass implementing the methods that are to be mocked.

To use, construct with the interface to be mocked (only one allowed, due to Java parameterization), then call getInstance() to create the proxy instance.

By default, all invocations are counted and the invocation arguments retained. See getInvocationCount(java.lang.String) and #getInvocationArgument for more information.

Constructor Summary

Constructors

Constructor and Description
SelfMock(Class<MockedType> klass)

Method Summary

Modifier and Type	Method and Description
MockedType	getInstance() Returns a proxy instance that passes invocations to this mock.
<T> T	getInvocationArg(String methodName, int invocationIndex, int argumentIndex, Class<T> argType) Returns a specific invocation argument, cast to a particular type.
Object[]	getInvocationArgs(String methodName, int invocationIndex) Returns the arguments passed to a particular invocation of the named method (using zero-based counting).
int	getInvocationCount(String methodName) Returns the number of times the named function was invoked.
<T> T	getMostRecentInvocationArg(String methodName, int argumentIndex, Class<T> argType) The a specific argument from the most recent invocation, cast to a particular type.
Object[]	getMostRecentInvocationArgs(String methodName) Returns the arguments passed to the most recent invocation of the named method.This is primarily useful when dealing with overloaded methods, where you might not know what types the arguments are.
Object	invoke(Object proxy, Method method, Object[] args)

Methods inherited from class java.lang.Object

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

Constructor Detail

SelfMock

public SelfMock(Class<MockedType> klass)

Method Detail

getInstance

public MockedType getInstance()

Returns a proxy instance that passes invocations to this mock. Multiple calls will return different proxy instances.

getInvocationCount

public int getInvocationCount(String methodName)

Returns the number of times the named function was invoked. This does not differentiate between overloaded methods: all methods with the same name is counted together.

getInvocationArgs

public Object[] getInvocationArgs(String methodName,
                                  int invocationIndex)

Returns the arguments passed to a particular invocation of the named method (using zero-based counting). This is primarily useful when dealing with overloaded methods, where you might not know what types the arguments are. If you know the arguments, #getInvocationArgAs is a better choice.

Note: this method returns the actual argument array that was passed to the invocation handler. Don't modify it unless you want to invalidate your tests.

Throws:

IndexOutOfBoundsException - if accessing a call that was never made.

getInvocationArg

public <T> T getInvocationArg(String methodName,
                              int invocationIndex,
                              int argumentIndex,
                              Class<T> argType)

Returns a specific invocation argument, cast to a particular type. Both indexes are zero-based.

getMostRecentInvocationArgs

public Object[] getMostRecentInvocationArgs(String methodName)

Returns the arguments passed to the most recent invocation of the named method.This is primarily useful when dealing with overloaded methods, where you might not know what types the arguments are. If you know the arguments, #getInvocationArgAs is a better choice.

Note: this method returns the actual argument array that was passed to the invocation handler. Don't modify it unless you want to invalidate your tests.

getMostRecentInvocationArg

public <T> T getMostRecentInvocationArg(String methodName,
                                        int argumentIndex,
                                        Class<T> argType)

The a specific argument from the most recent invocation, cast to a particular type.

invoke

public Object invoke(Object proxy,
                     Method method,
                     Object[] args)
              throws Throwable

Specified by:

invoke in interface InvocationHandler

Throws:

Throwable