net.jqwik.api.lifecycle

Enum PropagationMode

java.lang.Object

java.lang.Enum<PropagationMode>

net.jqwik.api.lifecycle.PropagationMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PropagationMode>

@API(status=EXPERIMENTAL,
     since="1.2.4")
public enum PropagationMode
extends java.lang.Enum<PropagationMode>

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 LifecycleHook.propagateTo()
• Use annotation attribute AddLifecycleHook.propagateTo()

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL_DESCENDANTS Propagate to all children and their children
DIRECT_DESCENDANTS Propagate only to direct children
NO_DESCENDANTS Do not propagate to any children
NOT_SET Default of AddLifecycleHook.propagateTo().

Method Summary

Modifier and Type	Method and Description
static PropagationMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static PropagationMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NOT_SET

public static final PropagationMode NOT_SET

Default of AddLifecycleHook.propagateTo(). Never use yourself.

ALL_DESCENDANTS

public static final PropagationMode ALL_DESCENDANTS

Propagate to all children and their children

DIRECT_DESCENDANTS

public static final PropagationMode DIRECT_DESCENDANTS

Propagate only to direct children

NO_DESCENDANTS

public static final PropagationMode NO_DESCENDANTS

Do not propagate to any children

Method Detail

values

public static PropagationMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (PropagationMode c : PropagationMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PropagationMode valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null