Package org.mockito.internal.util

Class DefaultMockingDetails

java.lang.Object
org.mockito.internal.util.DefaultMockingDetails
All Implemented Interfaces:
MockingDetails
public class DefaultMockingDetails extends Object implements MockingDetails
Class to inspect any object, and identify whether a particular object is either a mock or a spy. This is a wrapper for MockUtil.

  • Constructor Details

    • DefaultMockingDetails

      public DefaultMockingDetails(Object toInspect)

  • Method Details

    • isMock

      public boolean isMock()
      Description copied from interface: MockingDetails
      Informs if the object is a mock. isMock() for null input returns false.
      Specified by:
      isMock in interface MockingDetails
      Returns:
      true if the object is a mock or a spy (spy is a different kind of mock, but it is still a mock).

    • isSpy

      public boolean isSpy()
      Description copied from interface: MockingDetails
      Informs if the object is a spy. isSpy() for null input returns false.
      Specified by:
      isSpy in interface MockingDetails
      Returns:
      true if the object is a spy.

    • getInvocations

      public Collection<Invocation> getInvocations()
      Description copied from interface: MockingDetails
      All method invocations on this mock. Can be empty - it means there were no interactions with the mock.

      This method is useful for framework integrators and for certain edge cases.

      Manipulating the collection (e.g. by removing, adding elements) is safe and has no effect on the mock.

      Throws meaningful exception when object wrapped by MockingDetails is not a mock.

      Specified by:
      getInvocations in interface MockingDetails

    • getMockCreationSettings

      public MockCreationSettings<?> getMockCreationSettings()
      Description copied from interface: MockingDetails
      Returns various mock settings provided when the mock was created, for example: mocked class, mock name (if any), any extra interfaces (if any), etc. See also MockCreationSettings.

      This method is useful for framework integrators and for certain edge cases.

      If null or non-mock was passed to Mockito.mockingDetails(Object) then this method will throw with an appropriate exception. After all, non-mock objects do not have any mock creation settings.

      Specified by:
      getMockCreationSettings in interface MockingDetails

    • getStubbings

      public Collection<Stubbing> getStubbings()
      Description copied from interface: MockingDetails
      Returns stubbings declared on this mock object. 
      
   Mockito.mockingDetails(mock).getStubbings()
      What is 'stubbing'? Stubbing is your when(x).then(y) declaration, e.g. configuring the mock to behave in a specific way, when specific method with specific arguments is invoked on a mock. Typically, stubbing is configuring mock to return X when method Y is invoked.

      Why do you need to access stubbings of a mock? In a normal workflow of creation clean tests, there is no need for this API. However, it is useful for advanced users, edge cases or framework integrators. For example, Mockito internally uses this API to report and detect unused stubbings that should be removed from test. Unused stubbings are dead code that needs to be removed (see MockitoHint).

      Manipulating the collection (e.g. by removing, adding elements) is safe and has no effect on the mock.

      This method throws meaningful exception when object wrapped by MockingDetails is not a mock.

      Specified by:
      getStubbings in interface MockingDetails

    • printInvocations

      public String printInvocations()
      Description copied from interface: MockingDetails
      Returns printing-friendly list of the invocations that occurred with the mock object. Additionally, this method prints stubbing information, including unused stubbings. For more information about unused stubbing detection see MockitoHint.

      You can use this method for debugging, print the output of this method to the console to find out about all interactions with the mock.

      Content that is printed is subject to change as we discover better ways of presenting important mock information. Don't write code that depends on the output of this method. If you need to know about interactions and stubbings, use MockingDetails.getStubbings() and MockingDetails.getInvocations().

      This method throws meaningful exception when object wrapped by MockingDetails is not a mock.

      Specified by:
      printInvocations in interface MockingDetails

    • getMockHandler

      public MockHandler getMockHandler()
      Description copied from interface: MockingDetails
      Returns the MockHandler associated with this mock object. The handler is the core of mock object method handling. This method is useful for framework integrators. For example, other frameworks may use mock handler to simulate method calls on the Mock object.
      Specified by:
      getMockHandler in interface MockingDetails
      Returns:
      mock handler instance of this mock

    • getMock

      public Object getMock()
      Description copied from interface: MockingDetails
      Returns the mock object which is associated with this this instance of MockingDetails. Basically, it's the object that you have passed to Mockito.mockingDetails(Object) method.
      Specified by:
      getMock in interface MockingDetails
      Returns:
      the mock object of this mocking details instance