org.mockito.stubbing.Answer1 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 single argument invocation.
 *
 * Answer specifies an action that is executed and a return value that is returned when you interact with the mock.
 * 
 * Example of stubbing a mock with this custom answer:
 *
 * 

 * when(mock.someMethod(anyString())).thenAnswer(new Answer<Integer, String>() {
 *     Integer answer(String arg) {
 *         return arg.length();
 *     }
 * });
 *
 * //Following will print "3"
 * System.out.println(mock.someMethod("foo"));
 * 
 *
 * @param  return type
 * @param  type of the single argument
 * @see Answer
 */
@Incubating
public interface Answer1 {
    /**
     * @param argument0 the single argument.
     *
     * @return the value to be returned.
     *
     * @throws Throwable the throwable to be thrown
     */
    T answer(A0 argument0) throws Throwable;
}