org.mockito.MockitoFramework Maven / Gradle / Ivy
Show all versions of mockito-core Show documentation
/*
* Copyright (c) 2016 Mockito contributors
* This program is made available under the terms of the MIT License.
*/
package org.mockito;
import org.mockito.exceptions.misusing.RedundantListenerException;
import org.mockito.invocation.Invocation;
import org.mockito.invocation.InvocationFactory;
import org.mockito.listeners.MockitoListener;
import org.mockito.plugins.MockitoPlugins;
/**
* Mockito framework settings and lifecycle listeners, for advanced users or for integrating with other frameworks.
*
* To get MockitoFramework instance use {@link Mockito#framework()}.
*
* For more info on listeners see {@link #addListener(MockitoListener)}.
*
* @since 2.1.0
*/
@NotExtensible
public interface MockitoFramework {
/**
* Adds listener to Mockito.
* For a list of supported listeners, see the interfaces that extend {@link MockitoListener}.
*
* Listeners can be useful for engs that extend Mockito framework.
* They are used in the implementation of unused stubbings warnings ({@link org.mockito.quality.MockitoHint}).
*
* Make sure you remove the listener when the job is complete, see {@link #removeListener(MockitoListener)}.
* Currently the listeners list is thread local so you need to remove listener from the same thread otherwise
* remove is ineffectual.
* In typical scenarios, it is not a problem, because adding and removing listeners typically happens in the same thread.
*
* If you are trying to add the listener but a listener of the same type was already added (and not removed)
* this method will throw {@link RedundantListenerException}.
* This is a safeguard to ensure users actually remove the listeners via {@link #removeListener(MockitoListener)}.
* We do not anticipate the use case where adding the same listener type multiple times is useful.
* If this safeguard is problematic, please contact us via Mockito issue tracker.
*
* For usage examples, see Mockito codebase.
* If you have ideas and feature requests about Mockito listeners API
* we are very happy to hear about it via our issue tracker or mailing list.
*
*
* Mockito.framework().addListener(myListener);
*
*
* @param listener to add to Mockito
* @return this instance of mockito framework (fluent builder pattern)
* @since 2.1.0
*/
MockitoFramework addListener(MockitoListener listener) throws RedundantListenerException;
/**
* When you add listener using {@link #addListener(MockitoListener)} make sure to remove it.
* Currently the listeners list is thread local so you need to remove listener from the same thread otherwise
* remove is ineffectual.
* In typical scenarios, it is not a problem, because adding and removing listeners typically happens in the same thread.
*
* For usage examples, see Mockito codebase.
* If you have ideas and feature requests about Mockito listeners API
* we are very happy to hear about it via our issue tracker or mailing list.
*
* @param listener to remove
* @return this instance of mockito framework (fluent builder pattern)
* @since 2.1.0
*/
MockitoFramework removeListener(MockitoListener listener);
/**
* Returns an object that has access to Mockito plugins.
* An example plugin is {@link org.mockito.plugins.MockMaker}.
* For information why and how to use this method see {@link MockitoPlugins}.
*
* @return object that gives access to mockito plugins
* @since 2.10.0
*/
MockitoPlugins getPlugins();
/**
* Returns a factory that can create instances of {@link Invocation}.
* It is useful for framework integrations, because {@link Invocation} is {@link NotExtensible}.
*
* @return object that can construct invocations
* @since 2.10.0
*/
InvocationFactory getInvocationFactory();
/**
* Clears up internal state of all inline mocks.
* This method is only meaningful if inline mock maker is in use.
* Otherwise this method is a no-op and need not be used.
*
* This method is useful to tackle subtle memory leaks that are possible due to the nature of inline mocking
* (issue #1619).
* If you are facing those problems, call this method at the end of the test (or in "@After" method).
* See examples of using "clearInlineMocks" in Mockito test code.
* To find out why inline mock maker keeps track of the mock objects see {@link org.mockito.plugins.InlineMockMaker}.
*
* Mockito's "inline mocking" enables mocking final types, enums and final methods
* (read more in section 39 of {@link Mockito} javadoc).
* This method is only meaningful when {@link org.mockito.plugins.InlineMockMaker} is in use.
* If you're using a different {@link org.mockito.plugins.MockMaker} then this method is a no-op.
*
*
* public class ExampleTest {
*
* @After
* public void clearMocks() {
* Mockito.framework().clearInlineMocks();
* }
*
* @Test
* public void someTest() {
* ...
* }
* }
*
*
* If you have feedback or a better idea how to solve the problem please reach out.
*
* @since 2.25.0
* @see #clearInlineMock(Object)
*/
void clearInlineMocks();
/**
* Clears up internal state of specific inline mock.
* This method is a single-mock variant of {@link #clearInlineMocks()}.
* Please read javadoc for {@link #clearInlineMocks()}.
*
* @param mock to clear up
* @since 2.25.0
* @see #clearInlineMocks()
*/
void clearInlineMock(Object mock);
}