Package org.mockito.internal.stubbing.answers

Class ReturnsArgumentAt

java.lang.Object

org.mockito.internal.stubbing.answers.ReturnsArgumentAt

All Implemented Interfaces:

Serializable, Answer<Object>, ValidableAnswer

public class ReturnsArgumentAt
extends Object
implements Answer<Object>, ValidableAnswer, Serializable

Returns the passed parameter identity at specified index.

The argumentIndex represents the index in the argument array of the invocation.

If this number equals -1 then the last argument is returned.

Since:

1.9.5

See Also:

• AdditionalAnswers
• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final int	LAST_ARGUMENT

Constructor Summary

Constructors

Constructor	Description
ReturnsArgumentAt(int wantedArgumentPosition)	Build the identity answer to return the argument at the given position in the argument array.

Method Summary

Modifier and Type	Method	Description
Object	answer(InvocationOnMock invocation)
void	validateFor(InvocationOnMock invocationOnMock)	Validation of the answer at stub time for the given invocation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

LAST_ARGUMENT

public static final int LAST_ARGUMENT

See Also:

• Constant Field Values

Constructor Details

ReturnsArgumentAt

public ReturnsArgumentAt(int wantedArgumentPosition)

Build the identity answer to return the argument at the given position in the argument array.

Parameters:

wantedArgumentPosition - The position of the argument identity to return in the invocation. Using -1 indicates the last argument (LAST_ARGUMENT).

Method Details

answer

public Object answer(InvocationOnMock invocation)
              throws Throwable

Specified by:

answer in interface Answer<Object>

Parameters:

invocation - the invocation on the mock.

Returns:

the value to be returned

Throws:

Throwable - the throwable to be thrown

validateFor

public void validateFor(InvocationOnMock invocationOnMock)

Description copied from interface: ValidableAnswer

Validation of the answer at stub time for the given invocation.

This method will be called by Mockito.

The implementation must throw an MockitoException to indicate that this answer is not valid for the given invocation. If the validation succeed the implementation must simply return without throwing.

Specified by:

validateFor in interface ValidableAnswer

Parameters:

invocationOnMock - The stubbed invocation