Package org.powermock.core
Class MockRepository
java.lang.Object
org.powermock.core.MockRepository
Hold mock objects that should be used instead of the concrete implementation.
Mock transformers may use this class to gather information on which classes
and methods that are mocked.
-
Field Summary
FieldsModifier and TypeFieldDescriptionSometimes mock frameworks needs to store additional state.Set of runnables that will be executed after the test (method) is completed.private static Map<Class<?>,
MethodInvocationControl> Holds info about general method invocation mocks for classes.private static Map<Object,
MethodInvocationControl> Holds info about general method invocation mocks for instances.private static Map<Method,
InvocationHandler> Holds info about which methods that are proxied.private static Map<Class<?>,
NewInvocationControl<?>> Holds info about which methods that should return a substitute/another instance instead of the default instance.private static final Set<Constructor<?>>
Set of constructors that should be suppressed.Set of methods that should be suppressed.Set of field types that should always be suppressed regardless of instance.Set of methods that should be suppressed.Holds info about which class that should have their static initializers suppressed. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic void
addAfterMethodRunner
(Runnable runnable) Add aRunnable
that will be executed after each teststatic void
addConstructorToSuppress
(Constructor<?> constructor) Add a constructor to suppress.static void
addFieldToSuppress
(Field field) Add a field to suppress.static void
addFieldTypeToSuppress
(String fieldType) Add a field type to suppress.static void
addMethodToSuppress
(Method method) Add a method to suppress.static void
addObjectsToAutomaticallyReplayAndVerify
(Object... objects) Add classes that should be automatically replayed or verified.static void
addSuppressStaticInitializer
(String className) Add a fully qualified class name for a class that should have its static initializers suppressed.static void
clear()
Clear all state of the mock repository except for static initializers.static <T> T
getAdditionalState
(String key) Retrieve state based on the supplied key.static MethodInvocationControl
getInstanceMethodInvocationControl
(Object instance) static InvocationHandler
getMethodProxy
(Method method) static Object
getMethodToStub
(Method method) static NewInvocationControl<?>
getNewInstanceControl
(Class<?> type) static MethodInvocationControl
getStaticMethodInvocationControl
(Class<?> type) static boolean
hasMethodProxy
(Method method) static Object
putAdditionalState
(String key, Object value) When a mock framework API needs to store additional state not applicable for the other methods, it may use this method to do so.static MethodInvocationControl
putInstanceMethodInvocationControl
(Object instance, MethodInvocationControl invocationControl) static InvocationHandler
putMethodProxy
(Method method, InvocationHandler invocationHandler) Set a proxy for a method.static Object
putMethodToStub
(Method method, Object value) Set a substitute return value for a method.static NewInvocationControl<?>
putNewInstanceControl
(Class<?> type, NewInvocationControl<?> control) static MethodInvocationControl
putStaticMethodInvocationControl
(Class<?> type, MethodInvocationControl invocationControl) static void
Removes an object from the MockRepository if it exists.static Object
static MethodInvocationControl
removeClassMethodInvocationControl
(Class<?> type) static MethodInvocationControl
static InvocationHandler
removeMethodProxy
(Method method) static void
removeSuppressStaticInitializer
(String className) Remove a fully qualified class name for a class that should no longer have its static initializers suppressed.static boolean
shouldStubMethod
(Method method) static boolean
shouldSuppressConstructor
(Constructor<?> constructor) static boolean
shouldSuppressField
(Field field) static boolean
shouldSuppressMethod
(Method method, Class<?> objectType) static boolean
shouldSuppressStaticInitializerFor
(String className) Check whether or not a class with the fully qualified name should have its static initializers suppressed.
-
Field Details
-
objectsToAutomaticallyReplayAndVerify
-
newSubstitutions
-
classMocks
Holds info about general method invocation mocks for classes. -
instanceMocks
Holds info about general method invocation mocks for instances. -
substituteReturnValues
Holds info about which methods that should return a substitute/another instance instead of the default instance. -
methodProxies
Holds info about which methods that are proxied. -
suppressStaticInitializers
Holds info about which class that should have their static initializers suppressed. -
additionalState
Sometimes mock frameworks needs to store additional state. They can do this using this key/value based approach. -
suppressConstructor
Set of constructors that should be suppressed. -
suppressMethod
Set of methods that should be suppressed. -
suppressField
Set of methods that should be suppressed. -
suppressFieldTypes
Set of field types that should always be suppressed regardless of instance. -
afterMethodRunners
Set of runnables that will be executed after the test (method) is completed.
-
-
Constructor Details
-
MockRepository
public MockRepository()
-
-
Method Details
-
clear
public static void clear()Clear all state of the mock repository except for static initializers. The reason for not clearing static initializers is that when running in a suite with many tests the clear method is invoked after each test. This means that before the test that needs to suppress the static initializer has been reach the state of the MockRepository would have been wiped out. This is generally not a problem because most state will be added again but suppression of static initializers are different because this state can only be set once per class per CL. That's why we cannot remove this state. -
remove
Removes an object from the MockRepository if it exists. -
getStaticMethodInvocationControl
-
putStaticMethodInvocationControl
public static MethodInvocationControl putStaticMethodInvocationControl(Class<?> type, MethodInvocationControl invocationControl) -
removeClassMethodInvocationControl
-
getInstanceMethodInvocationControl
-
putInstanceMethodInvocationControl
public static MethodInvocationControl putInstanceMethodInvocationControl(Object instance, MethodInvocationControl invocationControl) -
removeInstanceMethodInvocationControl
-
getNewInstanceControl
-
putNewInstanceControl
public static NewInvocationControl<?> putNewInstanceControl(Class<?> type, NewInvocationControl<?> control) -
addSuppressStaticInitializer
Add a fully qualified class name for a class that should have its static initializers suppressed.- Parameters:
className
- The fully qualified class name for a class that should have its static initializers suppressed.
-
removeSuppressStaticInitializer
Remove a fully qualified class name for a class that should no longer have its static initializers suppressed.- Parameters:
className
- The fully qualified class name for a class that should no longer have its static initializers suppressed.
-
shouldSuppressStaticInitializerFor
Check whether or not a class with the fully qualified name should have its static initializers suppressed.- Parameters:
className
-true
if class with the fully qualified nameclassName
should have its static initializers suppressed,false
otherwise.
-
getObjectsToAutomaticallyReplayAndVerify
- Returns:
- All classes that should be automatically replayed or verified.
-
addObjectsToAutomaticallyReplayAndVerify
Add classes that should be automatically replayed or verified. -
putAdditionalState
When a mock framework API needs to store additional state not applicable for the other methods, it may use this method to do so.- Parameters:
key
- The key under which the value is stored.value
- The value to store under the specified key.- Returns:
- The previous object under the specified key or
null
.
-
removeAdditionalState
-
removeMethodProxy
-
getAdditionalState
Retrieve state based on the supplied key. -
addMethodToSuppress
Add a method to suppress.- Parameters:
method
- The method to suppress.
-
addFieldToSuppress
Add a field to suppress.- Parameters:
field
- The field to suppress.
-
addFieldTypeToSuppress
Add a field type to suppress. All fields of this type will be suppressed.- Parameters:
fieldType
- The fully-qualified name to a type. All fields of this type will be suppressed.
-
addConstructorToSuppress
Add a constructor to suppress.- Parameters:
constructor
- The constructor to suppress.
-
hasMethodProxy
- Returns:
true
if the method should be proxied.
-
shouldSuppressMethod
public static boolean shouldSuppressMethod(Method method, Class<?> objectType) throws ClassNotFoundException - Returns:
true
if the method should be suppressed.- Throws:
ClassNotFoundException
-
shouldSuppressField
- Returns:
true
if the field should be suppressed.
-
shouldSuppressConstructor
- Returns:
true
if the constructor should be suppressed.
-
shouldStubMethod
- Returns:
true
if the method has a substitute return value.
-
getMethodToStub
- Returns:
- The substitute return value for a particular method, may be
null
.
-
putMethodToStub
Set a substitute return value for a method. Whenever this method will be called thevalue
will be returned instead.- Returns:
- The previous substitute value if any.
-
getMethodProxy
- Returns:
- The proxy for a particular method, may be
null
.
-
putMethodProxy
Set a proxy for a method. Whenever this method is called the invocation handler will be invoked instead.- Returns:
- The method proxy if any.
-
addAfterMethodRunner
Add aRunnable
that will be executed after each test- Parameters:
runnable
-
-