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

import org.apiguardian.api.*;

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

/**
 * Implement this hook to define behaviour for a container (class or whole test suite)
 * that should be run exactly once before any of its property methods and child containers.
 */
@API(status = MAINTAINED, since = "1.4.0")
@FunctionalInterface
public interface BeforeContainerHook extends LifecycleHook {

	/**
	 * The code of this method will be run exactly once before any property method or child container.
	 *
	 * @param context The container's context object
	 */
	void beforeContainer(ContainerLifecycleContext context) throws Throwable;

	/**
	 * The higher the value, the closer to the actual property methods, i.e. the later it will be run.
	 * Default value is 0.
	 *
	 * 
	 * Values greater than -10 will make it run after methods annotated with {@linkplain BeforeContainer},
	 * values smaller than -10 will make it run before.
	 * 
	 *
	 * @return an integer value
	 */
	default int beforeContainerProximity() {
		return 0;
	}

	@API(status = INTERNAL)
	BeforeContainerHook DO_NOTHING = (containerLifecycleContext) -> {};

	@API(status = INTERNAL)
	default int compareTo(BeforeContainerHook other) {
		// The closer (higher proximity) the later it is called
		return Integer.compare(this.beforeContainerProximity(), other.beforeContainerProximity());
	}

}