mockit

Annotation Type Mock

@Inherited
 @Retention(value=RUNTIME)
 @Target(value=METHOD)
public @interface Mock

Used inside a mock-up class to indicate a mock 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 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, final, 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 static mocked method (or vice-versa), for example. Checked exceptions in the 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 static initializers of the mocked 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 mocked class hierarchy.

A mock method can specify constraints on the number of invocations it should receive while in effect (ie, from the time a real method/constructor is mocked to the time it is restored to its original definition).

See Also:

invocations, minInvocations, maxInvocations, Tutorial

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
int	invocations Number of expected invocations of the mock method.
int	maxInvocations Maximum number of expected invocations of the mock method, if positive.
int	minInvocations Minimum number of expected invocations of the mock method, starting from 0 (zero, which is the default).

Element Detail

invocations

public abstract int invocations

Number of expected invocations of the mock method. If 0 (zero), no invocations will be expected. A negative value (the default) means there is no expectation on the number of invocations; that is, the mock can be called any number of times or not at all during any test which uses it.

A non-negative value is equivalent to setting minInvocations and maxInvocations to that same value.

See Also:

Tutorial

Default:

-1

maxInvocations

public abstract int maxInvocations

Maximum number of expected invocations of the mock method, if positive. If zero the mock is not expected to be called at all. A negative value (the default) means there is no expectation on the maximum number of invocations.

See Also:

invocations, minInvocations, Tutorial

Default:

-1

minInvocations

public abstract int minInvocations

Minimum number of expected invocations of the mock method, starting from 0 (zero, which is the default).

See Also:

invocations, maxInvocations, Tutorial

Default:

0