Package org.mockito.internal.invocation
Class InterceptedInvocation
- java.lang.Object
-
- org.mockito.internal.invocation.InterceptedInvocation
-
- All Implemented Interfaces:
java.io.Serializable
,VerificationAwareInvocation
,DescribedInvocation
,Invocation
,InvocationOnMock
public class InterceptedInvocation extends java.lang.Object implements Invocation, VerificationAwareInvocation
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description private java.lang.Object[]
arguments
private boolean
isIgnoredForVerification
private Location
location
private MockitoMethod
mockitoMethod
private MockReference<java.lang.Object>
mockRef
static RealMethod
NO_OP
private java.lang.Object[]
rawArguments
private RealMethod
realMethod
private int
sequenceNumber
private static long
serialVersionUID
private StubInfo
stubInfo
private boolean
verified
-
Constructor Summary
Constructors Constructor Description InterceptedInvocation(MockReference<java.lang.Object> mockRef, MockitoMethod mockitoMethod, java.lang.Object[] arguments, RealMethod realMethod, Location location, int sequenceNumber)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description java.lang.Object
callRealMethod()
calls real methodprivate boolean
equalArguments(java.lang.Object[] arguments)
boolean
equals(java.lang.Object o)
<T> T
getArgument(int index)
Returns casted argument at the given index.<T> T
getArgument(int index, java.lang.Class<T> clazz)
Returns casted argument at the given index.java.lang.Object[]
getArguments()
Returns arguments passed to the method.java.util.List<ArgumentMatcher>
getArgumentsAsMatchers()
Wraps each argument usingArgumentMatchers.eq(Object)
orAdditionalMatchers.aryEq(Object[])
Used internally for the purposes of human-readable invocation printing.Location
getLocation()
The place in the code where the invocation happened.java.lang.reflect.Method
getMethod()
returns the methodjava.lang.Object
getMock()
returns the mock objectMockitoMethod
getMockitoMethod()
Deprecated.Not used by Mockito but by mockito-scalaMockReference<java.lang.Object>
getMockRef()
Deprecated.Not used by Mockito but by mockito-scalajava.lang.Object[]
getRawArguments()
Returns unprocessed arguments whereasInvocationOnMock.getArguments()
returns arguments already processed (e.g.java.lang.Class<?>
getRawReturnType()
Returns unprocessed arguments whereasInvocationOnMock.getArguments()
returns arguments already processed (e.g.RealMethod
getRealMethod()
Deprecated.Not used by Mockito but by mockito-scalaint
getSequenceNumber()
int
hashCode()
void
ignoreForVerification()
Configures this invocation to be ignored for verify-no-more-invocations or verification in order.boolean
isIgnoredForVerification()
Informs if the invocation participates in verify-no-more-invocations or verification in order.boolean
isVerified()
void
markStubbed(StubInfo stubInfo)
Marks this invocation as stubbed.void
markVerified()
Marks this invocation as verified so that it will not cause verification error atMockito.verifyNoMoreInteractions(Object...)
StubInfo
stubInfo()
java.lang.String
toString()
Describes the invocation in the human friendly way.
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
- See Also:
- Constant Field Values
-
mockRef
private final MockReference<java.lang.Object> mockRef
-
mockitoMethod
private final MockitoMethod mockitoMethod
-
arguments
private final java.lang.Object[] arguments
-
rawArguments
private final java.lang.Object[] rawArguments
-
realMethod
private final RealMethod realMethod
-
sequenceNumber
private final int sequenceNumber
-
location
private final Location location
-
verified
private boolean verified
-
isIgnoredForVerification
private boolean isIgnoredForVerification
-
stubInfo
private StubInfo stubInfo
-
NO_OP
public static final RealMethod NO_OP
-
-
Constructor Detail
-
InterceptedInvocation
public InterceptedInvocation(MockReference<java.lang.Object> mockRef, MockitoMethod mockitoMethod, java.lang.Object[] arguments, RealMethod realMethod, Location location, int sequenceNumber)
-
-
Method Detail
-
isVerified
public boolean isVerified()
- Specified by:
isVerified
in interfaceInvocation
- Specified by:
isVerified
in interfaceVerificationAwareInvocation
- Returns:
- whether the invocation has been already verified.
Needed for
Mockito.verifyNoMoreInteractions(Object...)
-
getSequenceNumber
public int getSequenceNumber()
- Specified by:
getSequenceNumber
in interfaceInvocation
- Returns:
- the sequence number of the Invocation. Useful to determine the order of invocations. Used by verification in order.
-
getLocation
public Location getLocation()
Description copied from interface:DescribedInvocation
The place in the code where the invocation happened.- Specified by:
getLocation
in interfaceDescribedInvocation
- Specified by:
getLocation
in interfaceInvocation
- Returns:
- the location in code of this invocation.
-
getRawArguments
public java.lang.Object[] getRawArguments()
Description copied from interface:Invocation
Returns unprocessed arguments whereasInvocationOnMock.getArguments()
returns arguments already processed (e.g. varargs expended, etc.).- Specified by:
getRawArguments
in interfaceInvocation
- Returns:
- unprocessed arguments, exactly as provided to this invocation.
-
getRawReturnType
public java.lang.Class<?> getRawReturnType()
Description copied from interface:Invocation
Returns unprocessed arguments whereasInvocationOnMock.getArguments()
returns arguments already processed (e.g. varargs expended, etc.).- Specified by:
getRawReturnType
in interfaceInvocation
- Returns:
- unprocessed arguments, exactly as provided to this invocation.
-
markVerified
public void markVerified()
Description copied from interface:Invocation
Marks this invocation as verified so that it will not cause verification error atMockito.verifyNoMoreInteractions(Object...)
- Specified by:
markVerified
in interfaceInvocation
-
stubInfo
public StubInfo stubInfo()
- Specified by:
stubInfo
in interfaceInvocation
- Returns:
- the stubbing information for this invocation. May return null - this means the invocation was not stubbed.
-
markStubbed
public void markStubbed(StubInfo stubInfo)
Description copied from interface:Invocation
Marks this invocation as stubbed.- Specified by:
markStubbed
in interfaceInvocation
- Parameters:
stubInfo
- the information about stubbing.
-
isIgnoredForVerification
public boolean isIgnoredForVerification()
Description copied from interface:Invocation
Informs if the invocation participates in verify-no-more-invocations or verification in order.- Specified by:
isIgnoredForVerification
in interfaceInvocation
- Returns:
- whether this invocation should be ignored for the purposes of verify-no-more-invocations or verification in order.
-
ignoreForVerification
public void ignoreForVerification()
Description copied from interface:Invocation
Configures this invocation to be ignored for verify-no-more-invocations or verification in order. See alsoInvocation.isIgnoredForVerification()
- Specified by:
ignoreForVerification
in interfaceInvocation
-
getMock
public java.lang.Object getMock()
Description copied from interface:InvocationOnMock
returns the mock object- Specified by:
getMock
in interfaceInvocationOnMock
- Returns:
- mock object
-
getMethod
public java.lang.reflect.Method getMethod()
Description copied from interface:InvocationOnMock
returns the method- Specified by:
getMethod
in interfaceInvocationOnMock
- Returns:
- method
-
getArguments
public java.lang.Object[] getArguments()
Description copied from interface:InvocationOnMock
Returns arguments passed to the method. Vararg are expanded in this array.- Specified by:
getArguments
in interfaceInvocationOnMock
- Returns:
- arguments
-
getArgument
public <T> T getArgument(int index)
Description copied from interface:InvocationOnMock
Returns casted argument at the given index. Can lookup in expanded arguments formInvocationOnMock.getArguments()
. This method is preferred overInvocationOnMock.getArgument(int, Class)
for readability. Please read the documentation ofInvocationOnMock.getArgument(int, Class)
for an overview of situations when that method is preferred over this one.- Specified by:
getArgument
in interfaceInvocationOnMock
- Parameters:
index
- argument index- Returns:
- casted argument at the given index
-
getArgument
public <T> T getArgument(int index, java.lang.Class<T> clazz)
Description copied from interface:InvocationOnMock
Returns casted argument at the given index. This method is analogous toInvocationOnMock.getArgument(int)
, but is necessary to circumvent issues when dealing with generics. In general,InvocationOnMock.getArgument(int)
is the appropriate function to use. This particular function is only necessary if you are doing one of the following things:- You want to directly invoke a method on the result of
InvocationOnMock.getArgument(int)
. - You want to directly pass the result of the invocation into a function that accepts a generic parameter.
InvocationOnMock.getArgument(int)
instead, you can circumvent the compilation issues by storing the intermediate result into a local variable with the correct type.- Specified by:
getArgument
in interfaceInvocationOnMock
- Parameters:
index
- argument indexclazz
- class to cast the argument to- Returns:
- casted argument at the given index
- You want to directly invoke a method on the result of
-
getArgumentsAsMatchers
public java.util.List<ArgumentMatcher> getArgumentsAsMatchers()
Description copied from interface:Invocation
Wraps each argument usingArgumentMatchers.eq(Object)
orAdditionalMatchers.aryEq(Object[])
Used internally for the purposes of human-readable invocation printing.- Specified by:
getArgumentsAsMatchers
in interfaceInvocation
- Returns:
- a list of
ArgumentMatcher
wrapping each of this invocation arguments
-
callRealMethod
public java.lang.Object callRealMethod() throws java.lang.Throwable
Description copied from interface:InvocationOnMock
calls real methodWarning: depending on the real implementation it might throw exceptions
- Specified by:
callRealMethod
in interfaceInvocationOnMock
- Returns:
- whatever the real method returns / throws
- Throws:
java.lang.Throwable
- in case real method throws
-
getMockRef
@Deprecated public MockReference<java.lang.Object> getMockRef()
Deprecated.Not used by Mockito but by mockito-scala
-
getMockitoMethod
@Deprecated public MockitoMethod getMockitoMethod()
Deprecated.Not used by Mockito but by mockito-scala
-
getRealMethod
@Deprecated public RealMethod getRealMethod()
Deprecated.Not used by Mockito but by mockito-scala
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equals
in classjava.lang.Object
-
equalArguments
private boolean equalArguments(java.lang.Object[] arguments)
-
toString
public java.lang.String toString()
Description copied from interface:DescribedInvocation
Describes the invocation in the human friendly way.- Specified by:
toString
in interfaceDescribedInvocation
- Overrides:
toString
in classjava.lang.Object
- Returns:
- the description of this invocation.
-
-