net.jqwik.api.arbitraries.FunctionArbitrary Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jqwik-api Show documentation

Jqwik API module

There is a newer version: 1.9.2

package net.jqwik.api.arbitraries;

import java.util.*;
import java.util.function.*;

import org.apiguardian.api.*;

import net.jqwik.api.*;

import static org.apiguardian.api.API.Status.*;

/**
 * Fluent interface to configure arbitraries that represent functional types
 *
 * @param  The exact functional type to generate
 * @param  The return type of the functional interface
 */
@API(status = MAINTAINED, since = "1.3.0")
public interface FunctionArbitrary extends Arbitrary {

	/**
	 *
	 * @param  The exact functional type to generate. Must be same as {@code F}
	 *
	 * @param parameterCondition A predicate that's true when for the given list of parameters
	 *                              {@code answer} should be used to produce the function' result
	 * @param answer A function that produces a concrete answer or throws an exception
	 * @return A new instance of function arbitrary
	 */
	 FunctionArbitrary when(Predicate> parameterCondition, Function, R> answer);

}