mockit.Delegate Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jmockit Show documentation
Show all versions of jmockit Show documentation
JMockit is a Java toolkit for developer (unit/integration) testing.
It contains mocking APIs and other tools, supporting both JUnit and TestNG.
The mocking APIs allow all kinds of Java code, without testability restrictions, to be tested
in isolation from selected dependencies.
/*
* Copyright (c) 2006-2012 Rogério Liesenfeld
* This file is subject to the terms of the MIT license (see LICENSE.txt).
*/
package mockit;
/**
* An empty interface to be used with the {@link Expectations#result} field or the
* {@code Invocations#with(Delegate)} method, allowing test code
* to freely define invocation results or argument matching rules, respectively.
*
* The name and parameters of the delegate method must fit one of the following alternatives:
*
* -
* A method matching the signature of the recorded method/constructor.
* That is, they should have the same name and parameters. In the case of delegating a constructor, a delegate
* method should still be used, with name "$init".
* In this case, the delegate class can have any number of additional methods.
*
* -
* A single method with the same or a different name as the recorded method, but having the same
* parameters.
*
* -
* A single method with the same or a different name, but having no parameters even if the recorded
* method/constructor has one or more of them.
* In this case, argument values passed during replay are simply ignored as far as the delegate is concerned.
*
*
* Additionally, in any of the above three alternatives, the delegate method is allowed to declare an additional
* parameter of type {@link Invocation}.
* If said parameter is present, it must be the first one.
* At replay time, it will always receive a suitable object representing the associated invocation which happened to
* match the recorded expectation.
*
* When used with the {@code result} field, the result of a delegate method execution can be any return value compatible
* with the recorded method's return type, or a thrown error/exception.
*
* When used with the {@code with} method, the delegate method must return a {@code boolean}, being {@code true} for a
* successfully matched argument or {@code false} otherwise.
*
* At replay time, when the mocked method/constructor is called the corresponding "delegate" method will be called.
* The arguments passed to the delegate method will be the same as those received by the recorded invocation during
* replay.
* Even {@code static} methods in the mocked type can have delegates, which in turn can be static or not.
* The same is true for {@code private}, {@code final}, and {@code native} methods.
*
* In the Tutorial
*
* Sample tests:
* DocumentManager_JMockit_Test
*
* @param the type of the argument to be matched, when used with the {@code with(Delegate<T>)} method
*/
public interface Delegate
{
}