Package net.jqwik.api.lifecycle

Interface SkipExecutionHook

All Superinterfaces:

LifecycleHook

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@API(status=MAINTAINED,
     since="1.4.0")
@FunctionalInterface
public interface SkipExecutionHook
extends LifecycleHook

Use this hook to determine if an annotated element should be skipped during a test run or not. Evaluation of hooks is stopped as soon as a single hook returns SkipExecutionHook.SkipResult.skip(String).

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	SkipExecutionHook.SkipResult

Field Summary

Fields

Modifier and Type	Field	Description
static final SkipExecutionHook	DO_NOT_SKIP

Method Summary

Modifier and Type	Method	Description
SkipExecutionHook.SkipResult	shouldBeSkipped(LifecycleContext context)	Determine if an annotated element should be skipped or not.

Methods inherited from interface net.jqwik.api.lifecycle.LifecycleHook

appliesTo, propagateTo

Field Details

DO_NOT_SKIP

@API(status=INTERNAL)
static final SkipExecutionHook DO_NOT_SKIP

Method Details

shouldBeSkipped

SkipExecutionHook.SkipResult shouldBeSkipped(LifecycleContext context)

Determine if an annotated element should be skipped or not. In order to decide an implementor can use all information from context. Use SkipExecutionHook.SkipResult.doNotSkip() or SkipExecutionHook.SkipResult.skip(String) as return value.

Parameters:

context - An instance of ContainerLifecycleContext or PropertyLifecycleContext

Returns:

an instance of SkipExecutionHook.SkipResult