org.mockito

Interface MockitoFramework

@Incubating
public interface MockitoFramework

Mockito framework settings and lifecycle listeners, for advanced users or for integrating with other frameworks.

To get MockitoFramework instance use Mockito.framework().

For more info on listeners see addListener(MockitoListener).

Since:

2.*

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(MockitoListener listener) Adds listener to Mockito.
void	removeListener(MockitoListener listener) When you add listener using addListener(MockitoListener) make sure to remove it.
void	setStubbingListener(StubbingListener listener) Sets new StubbingListener.

Method Detail

setStubbingListener

@Incubating
void setStubbingListener(StubbingListener listener)

Sets new StubbingListener. null is permitted and removes any previously set listener. If you set the stubbing listener, ensure that you have cleared it afterwards. See examples in Mockito codebase how setStubbingListener(StubbingListener) is used.

addListener

@Incubating
void addListener(MockitoListener listener)

Adds listener to Mockito. For a list of supported listeners, see the interfaces that extend MockitoListener.

Listeners can be useful for engs that extend Mockito framework. They are used in the implementation of unused stubbings warnings (MockitoHint).

Make sure you remove the listener when the job is complete, see 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 & 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.

   Mockito.framework().addListener(myListener);
 

Parameters:

listener - to add

removeListener

@Incubating
void removeListener(MockitoListener listener)

When you add listener using 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 & 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.

Parameters:

listener - to remove