mockit.Mock 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 automated developer testing.
It contains mocking/faking APIs and a code coverage tool, 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 Rogério Liesenfeld
* This file is subject to the terms of the MIT license (see LICENSE.txt).
*/
package mockit;
import java.lang.annotation.*;
/**
* Used inside a {@linkplain MockUp mock-up} class to indicate a mock (fake) method whose implementation will
* temporarily replace the implementation of a matching "real" method.
*
* The mock method must have the same name and the same parameters as the matching real method, except for an optional
* first parameter of type {@link Invocation}; if this extra parameter is present, the remaining ones must match the
* parameters in the real method.
* The mock method must also have the same return type as the matching real method.
*
* Method modifiers (public, {@code final}, {@code static}, etc.) between mock and mocked
* methods don't have to be the same.
* It's perfectly fine to have a non-static mock method for a {@code static} mocked method (or vice-versa),
* for example.
* Checked exceptions in the {@code throws} clause (if any) can also differ between the two matching methods.
*
* A mock method can also target a constructor, in which case the previous considerations still apply,
* except for the name of the mock method which must be "$init".
*
* Another special mock method, "void $clinit()", will target the {@code static}
* initializers of the faked class, if present in the mock-up class.
*
* Yet another special mock method is "Object $advice(Invocation)", which if defined will
* match every method in the target class hierarchy.
*
* @see Tutorial
*/
@Inherited
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface Mock
{
}