blob: 9f75bf5b9e9cabd510d0fea7cdf8929a377e10f5 [file] [log] [blame]
/*
* Copyright (c) 2016 Mockito contributors
* This program is made available under the terms of the MIT License.
*/
package org.mockito.stubbing;
import org.mockito.Incubating;
/**
* Generic interface to be used for configuring mock's answer for a single argument invocation that returns nothing.
*
* Answer specifies an action that is executed when you interact with the mock.
* <p>
* Example of stubbing a mock with this custom answer:
*
* <pre class="code"><code class="java">
* import static org.mockito.AdditionalAnswers.answerVoid;
*
* doAnswer(answerVoid(
* new VoidAnswer1&lt;String&gt;() {
* public void answer(String msg) throws Exception {
* throw new Exception(msg);
* }
* })).when(mock).someMethod(anyString());
*
* //Following will raise an exception with the message "boom"
* mock.someMethod("boom");
* </code></pre>
*
* @param <A0> type of the single argument
* @see Answer
*/
@Incubating
public interface VoidAnswer1<A0> {
/**
* @param argument0 the single argument.
*
* @throws Throwable the throwable to be thrown
*/
void answer(A0 argument0) throws Throwable;
}