org.mockito.configuration

Interface IMockitoConfiguration

All Known Implementing Classes:

DefaultMockitoConfiguration

public interface IMockitoConfiguration

Use it to configure Mockito. For now there are not many configuration options but it may change in future.

In most cases you don't really need to configure Mockito. For example in case of working with legacy code, when you might want to have different 'mocking style' this interface might be helpful. A reason of configuring Mockito might be if you disagree with the Answers.RETURNS_DEFAULTS unstubbed mocks return.

To configure Mockito create exactly org.mockito.configuration.MockitoConfiguration class that implements this interface.

Configuring Mockito is completely optional - nothing happens if there isn't any org.mockito.configuration.MockitoConfiguration on the classpath.

org.mockito.configuration.MockitoConfiguration must implement IMockitoConfiguration or extend DefaultMockitoConfiguration

Mockito will store single instance of org.mockito.configuration.MockitoConfiguration per thread (using ThreadLocal). For sanity of your tests, don't make the implementation stateful.

If you have comments on Mockito configuration feature don't hesitate to write to [email protected].

Method Summary

Modifier and Type	Method and Description
boolean	cleansStackTrace() This should be turned on unless you're a Mockito developer and you wish to have verbose (read: messy) stack traces that only few understand (eg: Mockito developers)
boolean	enableClassCache() Allow objenesis to cache classes.
AnnotationEngine	getAnnotationEngine() Deprecated. Please use the extension mechanism AnnotationEngine instead, this method will probably be removed in mockito 4.
Answer<Object>	getDefaultAnswer() Allows configuring the default answers of unstubbed invocations

Method Detail

getDefaultAnswer

Answer<Object> getDefaultAnswer()

Allows configuring the default answers of unstubbed invocations

See javadoc for IMockitoConfiguration

getAnnotationEngine

@Deprecated
AnnotationEngine getAnnotationEngine()

Deprecated. Please use the extension mechanism AnnotationEngine instead, this method will probably be removed in mockito 4.

Configures annotations for mocks.

This method will have lower priority that the new extension mechanism. That is if it exists on the classpath both a class org.mockito.configuration.MockitoConfiguration and a file mockito-extensions/org.mockito.plugins.AnnotationEngine then the implementation of org.mockito.configuration.MockitoConfiguration will be chosen instead of the one in the file.

See javadoc for IMockitoConfiguration

cleansStackTrace

boolean cleansStackTrace()

This should be turned on unless you're a Mockito developer and you wish to have verbose (read: messy) stack traces that only few understand (eg: Mockito developers)

See javadoc for IMockitoConfiguration

Returns:

if Mockito should clean stack traces

enableClassCache

boolean enableClassCache()

Allow objenesis to cache classes. If you're in an environment where classes are dynamically reloaded, you can disable this to avoid classcast exceptions.