Package org.mockito

Interface MockitoFramework

All Known Implementing Classes:
DefaultMockitoFramework
@NotExtensible 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.1.0

  • Method Details

    • addListener

      MockitoFramework addListener(MockitoListener listener) throws RedundantListenerException
      Adds listener to Mockito. For a list of supported listeners, see the interfaces that extend MockitoListener.

      Listeners can be useful for components 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 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 RedundantListenerException. This is a safeguard to ensure users actually remove the listeners via 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);
      Parameters:
      listener - to add to Mockito
      Returns:
      this instance of mockito framework (fluent builder pattern)
      Throws:
      RedundantListenerException
      Since:
      2.1.0

    • removeListener

      MockitoFramework 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 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.

      Parameters:
      listener - to remove
      Returns:
      this instance of mockito framework (fluent builder pattern)
      Since:
      2.1.0

    • getPlugins

      MockitoPlugins getPlugins()
      Returns an object that has access to Mockito plugins. An example plugin is MockMaker. For information why and how to use this method see MockitoPlugins.
      Returns:
      object that gives access to mockito plugins
      Since:
      2.10.0

    • getInvocationFactory

      InvocationFactory getInvocationFactory()
      Returns a factory that can create instances of Invocation. It is useful for framework integrations, because Invocation is NotExtensible.
      Returns:
      object that can construct invocations
      Since:
      2.10.0

    • clearInlineMocks

      void clearInlineMocks()
      Clears up internal state of all inline mocks. Attempts to interact with mocks after this is called will throw DisabledMockException.

      This method is only meaningful if inline mock maker is in use. For all other intents and purposes, 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 InlineMockMaker.

      Mockito's "inline mocking" enables mocking final types, enums and final methods (read more in section 39 of Mockito javadoc). This method is only meaningful when InlineMockMaker is in use. If you're using a different 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 Also:

    • clearInlineMock

      void clearInlineMock(Object mock)
      Clears up internal state of specific inline mock. This method is a single-mock variant of clearInlineMocks(). Please read javadoc for clearInlineMocks().
      Parameters:
      mock - to clear up
      Since:
      2.25.0
      See Also: