All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.mockito.configuration.IMockitoConfiguration Maven / Gradle / Ivy

There is a newer version: 5.13.0
Show newest version
/*
 * Copyright (c) 2007 Mockito contributors
 * This program is made available under the terms of the MIT License.
 */
package org.mockito.configuration;

import org.mockito.stubbing.Answer;

/**
 * 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 {@link org.mockito.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 {@link 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]. */ public interface IMockitoConfiguration { /** * Allows configuring the default answers of unstubbed invocations *

* See javadoc for {@link IMockitoConfiguration} */ Answer getDefaultAnswer(); /** * 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 {@link IMockitoConfiguration} * * @deprecated Please use the extension mechanism {@link org.mockito.plugins.AnnotationEngine} instead, * this method will probably be removed in mockito 3. */ @Deprecated AnnotationEngine getAnnotationEngine(); /** * 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 {@link IMockitoConfiguration} * * @return if Mockito should clean stack traces */ boolean cleansStackTrace(); /** * Allow objenesis to cache classes. If you're in an environment where classes * are dynamically reloaded, you can disable this to avoid classcast exceptions. */ boolean enableClassCache(); }