net.jqwik.api.lifecycle

Interface LifecycleHook

All Known Subinterfaces:

AfterContainerHook, AroundContainerHook, AroundPropertyHook, AroundTryHook, BeforeContainerHook, RegistrarHook, ResolveParameterHook, SkipExecutionHook

All Known Implementing Classes:

PerProperty.PerPropertyHook, PropertyDefaults.PropertyDefaultsHook

@API(status=EXPERIMENTAL,
     since="1.0")
public interface LifecycleHook

This is the supertype of all lifecycle hook interfaces. You can register a concrete implementation of a hook interface using AddLifecycleHook.

See Also:

SkipExecutionHook, BeforeContainerHook, AfterContainerHook, AroundContainerHook, AroundPropertyHook, AroundTryHook, ResolveParameterHook, RegistrarHook

Method Summary

Modifier and Type	Method and Description
default boolean	appliesTo(java.util.Optional<java.lang.reflect.AnnotatedElement> element) This method is called once per hook and potential element during lifecycle hooks registration.
default PropagationMode	propagateTo() 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.

Method Detail

appliesTo

@API(status=EXPERIMENTAL,
     since="1.2.4")
default boolean appliesTo(java.util.Optional<java.lang.reflect.AnnotatedElement> element)

This method is called once per hook and potential element during lifecycle hooks registration.

Parameters:

element - The Optional instance contains element for container classes or method but is empty for the engine

Returns:

true if a hook shall be applied to this element

propagateTo

@API(status=EXPERIMENTAL,
     since="1.2.4")
default PropagationMode propagateTo()

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.

Returns:

propagation mode enum