• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (c) 2016 Mockito contributors
3  * This program is made available under the terms of the MIT License.
4  */
5 package org.mockito.stubbing;
6 
7 import org.mockito.Incubating;
8 
9 /**
10  * Generic interface to be used for configuring mock's answer for a three argument invocation.
11  *
12  * Answer specifies an action that is executed and a return value that is returned when you interact with the mock.
13  * <p>
14  * Example of stubbing a mock with this custom answer:
15  *
16  * <pre class="code"><code class="java">
17  * import static org.mockito.AdditionalAnswers.answer;
18  *
19  * when(mock.someMethod(anyInt(), anyString(), anyChar())).then(answer(
20  *     new Answer3&lt;StringBuilder, Integer, String, Character&gt;() {
21  *         public StringBuilder answer(Integer i, String s, Character c) {
22  *             return new StringBuilder().append(i).append(s).append(c);
23  *         }
24  * }));
25  *
26  * //Following will print "3xyz"
27  * System.out.println(mock.someMethod(3, "xy", 'z'));
28  * </code></pre>
29  *
30  * @param <T> return type
31  * @param <A0> type of the first argument
32  * @param <A1> type of the second argument
33  * @param <A2> type of the third argument
34  * @see Answer
35  */
36 @Incubating
37 public interface Answer3<T, A0, A1, A2> {
38     /**
39      * @param argument0 the first argument.
40      * @param argument1 the second argument.
41      * @param argument2 the third argument.
42      *
43      * @return the value to be returned.
44      *
45      * @throws Throwable the throwable to be thrown
46      */
answer(A0 argument0, A1 argument1, A2 argument2)47     T answer(A0 argument0, A1 argument1, A2 argument2) throws Throwable;
48 }
49