net.jqwik.api.EdgeCases 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;

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

import org.apiguardian.api.*;
import org.jspecify.annotations.*;

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

@API(status = EXPERIMENTAL, since = "1.3.0")
public interface EdgeCases extends Iterable> {

	@API(status = INTERNAL)
	abstract class EdgeCasesFacade {
		private static final EdgeCases.EdgeCasesFacade implementation;

		static {
			implementation = FacadeLoader.load(EdgeCases.EdgeCasesFacade.class);
		}

		public abstract  EdgeCases fromSuppliers(List>> suppliers);
	}

	@API(status = MAINTAINED, since = "1.8.0")
	interface Config {

		static  Consumer> noConfig() {
			return config -> {};
		}

		/**
		 * Don't use any of the default edge cases
		 *
		 * @return same configuration instance
		 */
		Config none();

		/**
		 * Only include default edge cases for which {@linkplain #filter(Predicate)}  returns true
		 *
		 * @param filter A predicate
		 * @return same configuration instance
		 */
		Config filter(Predicate filter);

		/**
		 * Add one or more unshrinkable additional values as edge cases.
		 * In general, edge cases you add here must be values within the allowed value range
		 * of the current arbitrary.
		 * You add them as edge cases to make sure they are generated with a very high probability.
		 *
		 * 
		 * Some arbitraries may allow added values to be outside the allowed value range.
		 * This is mainly due to implementation issues and should not rely on it.
		 * Adding impossible values will - sadly enough - not raise an exception nor log a warning.
		 * 
		 *
		 * @param edgeCases The edge cases to add to default edge cases.
		 * @return same configuration instance
		 */
		@SuppressWarnings("unchecked")
		Config add(T... edgeCases);

		/**
		 * Include only the values given, and only if they are in the set of default edge cases.
		 *
		 * @param includedValues The values to be included
		 * @return same configuration instance
		 */
		@SuppressWarnings("unchecked")
		Config includeOnly(T... includedValues);
	}

	List>> suppliers();

	default int size() {
		return suppliers().size();
	}

	default boolean isEmpty() {
		return size() == 0;
	}

	default Iterator> iterator() {
		return suppliers().stream().map(Supplier::get).iterator();
	}

	@API(status = INTERNAL)
	static  EdgeCases fromSuppliers(List>> suppliers) {
		return EdgeCasesFacade.implementation.fromSuppliers(suppliers);
	}

	@API(status = INTERNAL)
	static  EdgeCases none() {
		return fromSuppliers(Collections.emptyList());
	}

	@API(status = INTERNAL)
	static  EdgeCases fromSupplier(Supplier> supplier) {
		return fromSuppliers(Collections.singletonList(supplier));
	}

}