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

import org.apiguardian.api.*;

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

/**
 * Use to register a concrete {@linkplain LifecycleHook lifecycle hook implementation}
 * for a test element -- a container class or a property method. More than one
 * hook can be registered.
 *
 * 
 *     This annotation can be used as meta annotation for self-made ones.
 * 
 */
@Target({ElementType.ANNOTATION_TYPE, ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Repeatable(LifecycleHooks.class)
@API(status = MAINTAINED, since = "1.4.0")
public @interface AddLifecycleHook {

	/**
	 * @return Concrete lifecycle hook implementation class
	 */
	Class value();

	/**
	 * Override the propagation mode specified in {@linkplain LifecycleHook#propagateTo()}.
	 *
	 * @return Propagation mode enum value
	 */
	PropagationMode propagateTo() default PropagationMode.NOT_SET;
}