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

/**
 * Describes if and how a concrete registered hook is propagated to children of
 * the element where the hook has been registered. The default behaviour
 * can be changed by:
 *
 * 
 *     Override {@linkplain LifecycleHook#propagateTo()}
 *     Use annotation attribute {@linkplain AddLifecycleHook#propagateTo()}
 * 
 */
@API(status = MAINTAINED, since = "1.4.0")
public enum PropagationMode {

	/**
	 * Default of {@linkplain AddLifecycleHook#propagateTo()}. Never use yourself.
	 */
	NOT_SET,

	/**
	 * Propagate to all children and their children
	 */
	ALL_DESCENDANTS,

	/**
	 * Propagate only to direct children
	 */
	DIRECT_DESCENDANTS,

	/**
	 * Do not propagate to any children
	 */
	NO_DESCENDANTS
}