Package net.jqwik.api.lifecycle

Interface LifecycleHook

All Known Subinterfaces:
AfterContainerHook, AroundContainerHook, AroundPropertyHook, AroundTryHook, BeforeContainerHook, InvokePropertyMethodHook, ProvidePropertyInstanceHook, RegistrarHook, ResolveParameterHook, SkipExecutionHook
All Known Implementing Classes:
PerProperty.PerPropertyHook, PropertyDefaults.PropertyDefaultsHook
@API(status=MAINTAINED, since="1.4.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:

  • Method Summary

    Modifier and Type
    Method
    Description
    default boolean
    appliesTo(Optional<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 Details

    • appliesTo

      default boolean appliesTo(Optional<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

      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