mockit

Class MockUp<T>

java.lang.Object

mockit.MockUp<T>

Type Parameters:

T - specifies the type to be faked; if a type variable is used, then all implementation classes extending or implementing that base type are also faked; if the type argument itself is a parameterized type, then only its raw type is considered

public class MockUp<T>
extends Object

A base class used in the creation of a fake for an external type, which is usually a class from some library or component used from the internal codebase of the system under test (SUT). Such fake classes can be used as fake implementations for use in unit or integration tests. For example:

 public final class FakeSystem extends MockUp<System> {
    @Mock public static long nanoTime() { return 123L; }
 }
 

One or more fake methods annotated as such must be defined in the concrete subclass. Each @Mock method should have a matching method or constructor in the faked class. At runtime, the execution of a faked method/constructor will get redirected to the corresponding fake method.

When the type to be faked is specified indirectly through a type variable, then that type is taken as a base type whose concrete implementation classes should also get faked. Example:

 @Test
 public <BC extends SomeBaseClass> void someTest() {
     new MockUp<BC>() {
        @Mock int someMethod(int i) { return i + 1; }
     };

     int i = new AConcreteSubclass().someMethod(1);
     assertEquals(2, i);
 }
 

See Also:

MockUp(), MockUp(Class), onTearDown(), targetType, Tutorial

Field Summary

Fields

Modifier and Type	Field and Description
protected Type	targetType Holds the class or generic type targeted by this fake instance.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MockUp() Applies the fake methods defined in the concrete subclass to the class specified through the type parameter.
protected	MockUp(Class<?> targetClass) Applies the fake methods defined in the fake class to the given class.

Method Summary

Modifier and Type	Method and Description
protected void	onTearDown() An empty method that can be overridden in a fake class that wants to be notified whenever the fake is automatically torn down.

Methods inherited from class java.lang.Object

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

Field Detail

targetType

@Nonnull
protected final Type targetType

Holds the class or generic type targeted by this fake instance.

Constructor Detail

MockUp

protected MockUp()

Applies the fake methods defined in the concrete subclass to the class specified through the type parameter.

MockUp

protected MockUp(@Nonnull
                 Class<?> targetClass)

Applies the fake methods defined in the fake class to the given class.

In most cases, the constructor with no parameters can be used. This variation is useful when the type to be faked is not known at compile time. For example, it can be used with an $advice method and the fakes system property in order to have an aspect-like fake implementation applicable to any class; it can then be applied at the beginning of the test run with the desired target class being specified in the test run configuration.

Method Detail

onTearDown

protected void onTearDown()

An empty method that can be overridden in a fake class that wants to be notified whenever the fake is automatically torn down. Tear down happens when the fake goes out of scope: at the end of the test when applied inside a test, at the end of the test class when applied before the test class, or at the end of the test run when applied through the "fakes" system property.

By default, this method does nothing.