net.jqwik.api.lifecycle.LifecycleHook 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 java.lang.reflect.*;
import java.util.*;

import org.apiguardian.api.*;

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

/**
 * This is the supertype of all lifecycle hook interfaces.
 * You can register a concrete implementation of a hook interface using
 * {@linkplain AddLifecycleHook}.
 *
 * @see SkipExecutionHook
 * @see BeforeContainerHook
 * @see AfterContainerHook
 * @see AroundContainerHook
 * @see AroundPropertyHook
 * @see AroundTryHook
 * @see ResolveParameterHook
 * @see RegistrarHook
 */
@API(status = MAINTAINED, since = "1.4.0")
public interface LifecycleHook {

	/**
	 * This method is called once per hook and potential element during lifecycle hooks registration.
	 *
	 * @param element The Optional instance contains element for container classes
	 *                or method but is empty for the engine
	 * @return true if a hook shall be applied to this element
	 */
	default boolean appliesTo(Optional element) {
		return true;
	}

	/**
	 * Override this method if you want to change a concrete hook implementation's default
	 * propagation behaviour: Do not use hook in child elements -- sub containers or properties.
	 *
	 * @return propagation mode enum
	 */
	default PropagationMode propagateTo() {
		return PropagationMode.NO_DESCENDANTS;
	}

}