net.jqwik.api.arbitraries.StreamableArbitrary 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
The newest version!
package net.jqwik.api.arbitraries;

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

import org.apiguardian.api.*;

import net.jqwik.api.*;

import org.jspecify.annotations.*;

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

/**
 * Fluent interface to add functionality to arbitraries whose generation artefacts
 * can be streamed, e.g. {@link List}, {@link Set}, {@link Stream} and Arrays
 */
@API(status = MAINTAINED, since = "1.2.1")
public interface StreamableArbitrary extends SizableArbitrary {

	/**
	 * Given an {@code initial} argument use {@code accumulator} to produce
	 * the final result.
	 *
	 * @param initial     The initial argument. Also the result if streamable is empty
	 * @param accumulator The function used to reduce a streamable into a result one by one
	 * @param          The result type
	 * @return The result of accumulating all elements in streamable
	 */
	 Arbitrary reduce(R initial, BiFunction accumulator);

	/**
	 * Fix the size to {@code size}.
	 */
	default StreamableArbitrary ofSize(int size) {
		return ofMinSize(size).ofMaxSize(size);
	}

	/**
	 * Set lower size boundary {@code minSize} (included).
	 */
	StreamableArbitrary ofMinSize(int minSize);

	/**
	 * Set upper size boundary {@code maxSize} (included).
	 */
	StreamableArbitrary ofMaxSize(int maxSize);

	/**
	 * Set distribution {@code distribution} of size of generated arbitrary
	 */
	@API(status = EXPERIMENTAL, since = "1.5.3")
	StreamableArbitrary withSizeDistribution(RandomDistribution distribution);

	/**
	 * Add the constraint that elements of the generated streamable must be unique,
	 * i.e. no two elements must return true when being compared using {@linkplain Object#equals(Object)}.
	 *
	 * 
	 *     The constraint can be combined with other {@linkplain #uniqueElements(Function)} constraints.
	 * 
	 *
	 * @return new arbitrary instance
	 */
	@API(status = MAINTAINED, since = "1.7.3")
	StreamableArbitrary uniqueElements();

	/**
	 * Add the constraint that elements of the generated streamable must be unique
	 * relating to an element's "feature" being extracted using the
	 * {@code by} function.
	 * The extracted features are being compared using {@linkplain Object#equals(Object)}.
	 *
	 * 
	 *     The constraint can be combined with other {@linkplain #uniqueElements(Function)} constraints.
	 * 
	 *
	 * @return new arbitrary instance
	 */
	@API(status = MAINTAINED, since = "1.7.3")
	StreamableArbitrary uniqueElements(Function by);

}