org.mockito.stubbing.VoidAnswer3 Maven / Gradle / Ivy

/*
 * 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 three argument invocation that returns nothing.
 *
 * Answer specifies an action that is executed when you interact with the mock.
 * 
 * Example of stubbing a mock with this custom answer:
 *
 * 

 * when(mock.someMethod(anyString(), anyInt(), anyString())).thenAnswer(new Answer<String, Integer, String>() {
 *     void answer(String msg, Integer count, String another) {
 *         throw new Exception(String.format(msg, another, count));
 *     }
 * });
 *
 * //Following will raise an exception with the message "ka-boom 3"
 * mock.someMethod("%s-boom %d", 3, "ka");
 * 
 *
 * @param  type of the first argument
 * @param  type of the second argument
 * @param  type of the third argument
 * @see Answer
 */
@Incubating
public interface VoidAnswer3 {
    /**
     * @param argument0 the first argument.
     * @param argument1 the second argument.
     * @param argument2 the third argument.
     *
     * @throws Throwable the throwable to be thrown
     */
    void answer(A0 argument0, A1 argument1, A2 argument2) throws Throwable;
}