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