org.mockito.AdditionalAnswers Maven / Gradle / Ivy
Show all versions of mockito-core Show documentation
/*
* Copyright (c) 2007 Mockito contributors
* This program is made available under the terms of the MIT License.
*/
package org.mockito;
import static org.mockito.internal.stubbing.answers.AnswerFunctionalInterfaces.toAnswer;
import java.util.Collection;
import org.mockito.internal.stubbing.answers.AnswersWithDelay;
import org.mockito.internal.stubbing.answers.ReturnsArgumentAt;
import org.mockito.internal.stubbing.answers.ReturnsElementsOf;
import org.mockito.internal.stubbing.defaultanswers.ForwardsInvocations;
import org.mockito.stubbing.Answer;
import org.mockito.stubbing.Answer1;
import org.mockito.stubbing.Answer2;
import org.mockito.stubbing.Answer3;
import org.mockito.stubbing.Answer4;
import org.mockito.stubbing.Answer5;
import org.mockito.stubbing.Answer6;
import org.mockito.stubbing.VoidAnswer1;
import org.mockito.stubbing.VoidAnswer2;
import org.mockito.stubbing.VoidAnswer3;
import org.mockito.stubbing.VoidAnswer4;
import org.mockito.stubbing.VoidAnswer5;
import org.mockito.stubbing.VoidAnswer6;
/**
* Additional answers provides factory methods for answers.
*
* Currently offer answers that can return the parameter of an invocation at a certain position,
* along with answers that draw on a strongly typed interface to provide a neater way to write custom answers
* that either return a value or are void (see answer interfaces in org.mockito.stubbing).
*
*
See factory methods for more information : {@link #returnsFirstArg}, {@link #returnsSecondArg},
* {@link #returnsLastArg}, {@link #returnsArgAt}, {@link #answer} and {@link #answerVoid}
*
* @since 1.9.5
*/
@SuppressWarnings("unchecked")
public final class AdditionalAnswers {
/**
* Returns the first parameter of an invocation.
*
*
* This additional answer could be used at stub time using the
* then|do|will{@link org.mockito.stubbing.Answer} methods. For example :
*
*
* given(carKeyFob.authenticate(carKey)).will(returnsFirstArg());
* doAnswer(returnsFirstArg()).when(carKeyFob).authenticate(carKey);
*
*
*
*
* This methods works with varargs as well, mockito will expand the vararg to return the argument
* at the given position. Suppose the following signature :
*
*
* interface Person {
* Dream remember(Dream... dreams);
* }
*
* // returns dream1
* given(person.remember(dream1, dream2, dream3, dream4)).will(returnsFirstArg());
*
*
* Mockito will return the vararg array if the first argument is a vararg in the method
* and if the return type has the same type as the vararg array.
*
*
* interface Person {
* Dream[] remember(Dream... otherDreams);
* }
*
* // returns otherDreams (happens to be a 4 elements array)
* given(person.remember(dream1, dream2, dream3, dream4)).will(returnsFirstArg());
*
*
*
* @param Return type of the invocation.
* @return Answer that will return the first argument of the invocation.
*
* @since 1.9.5
*/
public static Answer returnsFirstArg() {
return (Answer) new ReturnsArgumentAt(0);
}
/**
* Returns the second parameter of an invocation.
*
*
* This additional answer could be used at stub time using the
* then|do|will{@link org.mockito.stubbing.Answer} methods. For example :
*
*
* given(trader.apply(leesFormula, onCreditDefaultSwap)).will(returnsSecondArg());
* doAnswer(returnsSecondArg()).when(trader).apply(leesFormula, onCreditDefaultSwap);
*
*
*
*
* This methods works with varargs as well, mockito will expand the vararg to return the argument
* at the given position. Suppose the following signature :
*
*
* interface Person {
* Dream remember(Dream dream, Dream... otherDreams);
* }
*
* // returns dream2
* given(person.remember(dream1, dream2, dream3, dream4)).will(returnsSecondArg());
*
*
* Mockito will return the vararg array if the second argument is a vararg in the method
* and if the return type has the same type as the vararg array.
*
*
* interface Person {
* Dream[] remember(Dream dream1, Dream... otherDreams);
* }
*
* // returns otherDreams (happens to be a 3 elements array)
* given(person.remember(dream1, dream2, dream3, dream4)).will(returnsSecondArg());
*
*
*
* @param Return type of the invocation.
* @return Answer that will return the second argument of the invocation.
*
* @since 1.9.5
*/
public static Answer returnsSecondArg() {
return (Answer) new ReturnsArgumentAt(1);
}
/**
* Returns the last parameter of an invocation.
*
*
* This additional answer could be used at stub time using the
* then|do|will{@link org.mockito.stubbing.Answer} methods. For example :
*
*
* given(person.remember(dream1, dream2, dream3, dream4)).will(returnsLastArg());
* doAnswer(returnsLastArg()).when(person).remember(dream1, dream2, dream3, dream4);
*
*
*
*
* This methods works with varargs as well, mockito will expand the vararg to return the argument
* at the given position. Suppose the following signature :
*
*
* interface Person {
* Dream remember(Dream dream, Dream... otherDreams);
* }
*
* // returns dream4
* given(person.remember(dream1, dream2, dream3, dream4)).will(returnsLastArg());
*
*
* Mockito will return the vararg array if the given {@code position} targets the vararg index in the method
* and if the return type has the same type as the vararg array.
*
*
* interface Person {
* Dream[] remember(Dream dream1, Dream dream2, Dream dream3, Dream... otherDreams);
* }
*
* // returns otherDreams (happens to be a single element array)
* given(person.remember(dream1, dream2, dream3, dream4)).will(returnsLastArg());
*
*
*
* @param Return type of the invocation.
* @return Answer that will return the last argument of the invocation.
*
* @since 1.9.5
*/
public static Answer returnsLastArg() {
return (Answer) new ReturnsArgumentAt(ReturnsArgumentAt.LAST_ARGUMENT);
}
/**
* Returns the parameter of an invocation at the given position.
*
*
* This additional answer could be used at stub time using the
* then|do|will{@link org.mockito.stubbing.Answer} methods. For example :
*
*
* given(person.remember(dream1, dream2, dream3, dream4)).will(returnsArgAt(3));
* doAnswer(returnsArgAt(3)).when(person).remember(dream1, dream2, dream3, dream4);
*
*
*
*
* This methods works with varargs as well, mockito will expand the vararg to return the argument
* at the given position. Suppose the following signature :
*
*
* interface Person {
* Dream remember(Dream dream, Dream... otherDreams);
* }
*
* // returns dream 3
* given(person.remember(dream1, dream2, dream3, dream4)).will(returnsArgAt(2));
*
*
* Mockito will return the vararg array if the given {@code position} targets the vararg index in the method
* and if the return type has the same type as the vararg array.
*
*
* interface Person {
* Dream[] remember(Dream dream, Dream... otherDreams);
* }
*
* // returns otherDreams array (contains dream2, dream,3, dream4)
* given(person.remember(dream1, dream2, dream3, dream4)).will(returnsArgAt(1));
*
*
*
* @param Return type of the invocation.
* @param position index of the argument from the list of arguments.
* @return Answer that will return the argument from the given position in the argument's list
*
* @since 1.9.5
*/
public static Answer returnsArgAt(int position) {
return (Answer) new ReturnsArgumentAt(position);
}
/**
* An answer that directly forwards the calls to the delegate. The delegate may or may not be of the same type as the mock.
* If the type is different, a matching method needs to be found on delegate type otherwise an exception is thrown.
*
* Useful for spies or partial mocks of objects that are difficult to mock
* or spy using the usual spy API. Possible use cases:
*
* - Final classes but with an interface
* - Already custom proxied object
* - Special objects with a finalize method, i.e. to avoid executing it 2 times
*
*
*
* The difference with the regular spy:
*
* -
* The regular spy ({@link Mockito#spy(Object)}) contains all state from the spied instance
* and the methods are invoked on the spy. The spied instance is only used at mock creation to copy the state from.
* If you call a method on a regular spy and it internally calls other methods on this spy, those calls are remembered
* for verifications, and they can be effectively stubbed.
*
* -
* The mock that delegates simply delegates all methods to the delegate.
* The delegate is used all the time as methods are delegated onto it.
* If you call a method on a mock that delegates and it internally calls other methods on this mock,
* those calls are not remembered for verifications, stubbing does not have effect on them, too.
* Mock that delegates is less powerful than the regular spy but it is useful when the regular spy cannot be created.
*
*
* An example with a final class that we want to delegate to:
*
*
* final class DontYouDareToMockMe implements list { ... }
*
* DontYouDareToMockMe awesomeList = new DontYouDareToMockMe();
*
* List mock = mock(List.class, delegatesTo(awesomeList));
*
*
*
* This feature suffers from the same drawback as the spy.
* The mock will call the delegate if you use regular when().then() stubbing style.
* Since the real implementation is called this might have some side effects.
* Therefore you should use the doReturn|Throw|Answer|CallRealMethod stubbing style. Example:
*
*
* List listWithDelegate = mock(List.class, AdditionalAnswers.delegatesTo(awesomeList));
*
* //Impossible: real method is called so listWithDelegate.get(0) throws IndexOutOfBoundsException (the list is yet empty)
* when(listWithDelegate.get(0)).thenReturn("foo");
*
* //You have to use doReturn() for stubbing
* doReturn("foo").when(listWithDelegate).get(0);
*
*
* @param delegate The delegate to forward calls to. It does not have to be of the same type as the mock (although it usually is).
* The only requirement is that the instance should have compatible method signatures including the return values.
* Only the methods that were actually executed on the mock need to be present on the delegate type.
* @return the answer
*
* @since 1.9.5
*/
public static Answer delegatesTo(Object delegate) {
return (Answer) new ForwardsInvocations(delegate);
}
/**
* Returns elements of the collection. Keeps returning the last element forever.
* Might be useful on occasion when you have a collection of elements to return.
*
*
* //this:
* when(mock.foo()).thenReturn(1, 2, 3);
*
* //is equivalent to:
* when(mock.foo()).thenAnswer(AdditionalAnswers.returnsElementsOf(Arrays.asList(1, 2, 3)));
*
*
* @param elements The collection of elements to return.
* @return the answer
*
* @since 1.9.5
*/
public static Answer returnsElementsOf(Collection elements) {
return (Answer) new ReturnsElementsOf(elements);
}
/**
* Returns an answer after a delay with a defined length.
*
* @param return type
* @param sleepyTime the delay in milliseconds
* @param answer interface to the answer which provides the intended return value.
* @return the answer object to use
*
* @since 2.8.44
*/
public static Answer answersWithDelay(long sleepyTime, Answer answer) {
return (Answer) new AnswersWithDelay(sleepyTime, (Answer