public interface MockingDetails
Modifier and Type | Method and Description |
---|---|
Collection<Invocation> |
getInvocations()
All method invocations on this mock.
|
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.
|
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.
|
boolean isMock()
boolean isSpy()
Collection<Invocation> getInvocations()
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.
MockCreationSettings<?> getMockCreationSettings()
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.
Collection<Stubbing> getStubbings()
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.
String printInvocations()
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.