com.almasb.fxgl.ai.btree.branch

Enum Parallel.Policy

java.lang.Object

java.lang.Enum<Parallel.Policy>

com.almasb.fxgl.ai.btree.branch.Parallel.Policy

All Implemented Interfaces:

Serializable, Comparable<Parallel.Policy>

Enclosing class:

Parallel<E>

public static enum Parallel.Policy
extends Enum<Parallel.Policy>

The enumeration of the policies supported by the Parallel task.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Selector The selector policy makes the Parallel task succeed as soon as one child succeeds; if all children fail, then the parallel task fails.
Sequence The sequence policy makes the Parallel task fail as soon as one child fails; if all children succeed, then the parallel task succeeds.

Method Summary

Modifier and Type	Method and Description
abstract Boolean	onChildFail(Parallel<?> parallel) Called by parallel task each time one of its children fails.
abstract Boolean	onChildSuccess(Parallel<?> parallel) Called by parallel task each time one of its children succeeds.
static Parallel.Policy	valueOf(String name) Returns the enum constant of this type with the specified name.
static Parallel.Policy[]	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

Sequence

public static final Parallel.Policy Sequence

The sequence policy makes the Parallel task fail as soon as one child fails; if all children succeed, then the parallel task succeeds. This is the default policy.

Selector

public static final Parallel.Policy Selector

The selector policy makes the Parallel task succeed as soon as one child succeeds; if all children fail, then the parallel task fails.

Method Detail

values

public static Parallel.Policy[] 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 (Parallel.Policy c : Parallel.Policy.values())
    System.out.println(c);

Returns:

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

valueOf

public static Parallel.Policy valueOf(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:

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

NullPointerException - if the argument is null

onChildSuccess

public abstract Boolean onChildSuccess(Parallel<?> parallel)

Called by parallel task each time one of its children succeeds.

Parameters:

parallel - the parallel task

Returns:

Boolean.TRUE if parallel must succeed, Boolean.FALSE if parallel must fail and null if parallel must keep on running.

onChildFail

public abstract Boolean onChildFail(Parallel<?> parallel)

Called by parallel task each time one of its children fails.

Parameters:

parallel - the parallel task

Returns:

Boolean.TRUE if parallel must succeed, Boolean.FALSE if parallel must fail and null if parallel must keep on running.