org.mockito

Interface MockingDetails

public interface MockingDetails

Provides mocking information. For example, you can identify whether a particular object is either a mock or a spy. For examples and more information please refer to the javadoc of the individual methods on this class.

Since:

1.9.5

Method Summary

Modifier and Type	Method and Description
Collection<Invocation>	getInvocations() All method invocations on this mock.
Object	getMock() Returns the mock object which is associated with this this instance of MockingDetails.
MockCreationSettings<?>	getMockCreationSettings() Returns various mock settings provided when the mock was created, for example: mocked class, mock name (if any), any extra interfaces (if any), etc.
MockHandler	getMockHandler() Returns the MockHandler associated with this mock object.
Collection<Stubbing>	getStubbings() Returns stubbings declared on this mock object.
boolean	isMock() Informs if the object is a mock.
boolean	isSpy() Informs if the object is a spy.
String	printInvocations() Returns printing-friendly list of the invocations that occurred with the mock object.

Method Detail

isMock

boolean isMock()

Informs if the object is a mock. isMock() for null input returns false.

Returns:

true if the object is a mock or a spy (spy is a different kind of mock, but it is still a mock).

Since:

1.9.5

isSpy

boolean isSpy()

Informs if the object is a spy. isSpy() for null input returns false.

Returns:

true if the object is a spy.

Since:

1.9.5

getInvocations

Collection<Invocation> getInvocations()

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.

Since:

1.10.0

getMockCreationSettings

MockCreationSettings<?> getMockCreationSettings()

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.

Since:

2.1.0

getStubbings

Collection<Stubbing> getStubbings()

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.

Since:

2.2.3

printInvocations

String printInvocations()

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 getStubbings() and getInvocations().

This method was moved from the deprecated and semi-hidden type MockitoDebugger.

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

Since:

2.2.6

getMockHandler

@Incubating
MockHandler getMockHandler()

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.

Returns:

mock handler instance of this mock

Since:

2.10.0

getMock

Object getMock()

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.

Returns:

the mock object of this mocking details instance

Since:

2.11.0