org.mockito.configuration.IMockitoConfiguration Maven / Gradle / Ivy
/*
* Copyright (c) 2007 Mockito contributors
* This program is made available under the terms of the MIT License.
*/
package org.mockito.configuration;
import org.mockito.ReturnValues;
import org.mockito.internal.stubbing.defaultanswers.ReturnsEmptyValues;
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 ReturnsEmptyValues} 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]
*/
@SuppressWarnings("deprecation")//supressed until ReturnValues are removed
public interface IMockitoConfiguration {
/**
* @deprecated
* Please use {@link IMockitoConfiguration#getDefaultAnswer()}
*
* Steps:
*
* 1. Leave the implementation of getReturnValues() method empty - it's not going to be used anyway.
*
* 2. Implement getDefaultAnswer() instead.
*
* In rare cases your code might not compile with recent deprecation & changes.
* Very sorry for inconvenience but it had to be done in order to keep framework consistent.
*
* See javadoc {@link ReturnValues} for info why this method was deprecated
*
* Allows configuring the default return values of unstubbed invocations
*
* See javadoc for {@link IMockitoConfiguration}
*/
@Deprecated
ReturnValues getReturnValues();
/**
* Allows configuring the default answers of unstubbed invocations
*
* See javadoc for {@link IMockitoConfiguration}
*/
Answer