Package com.valhalla.sdk.tasks.tree

Class Leaf

java.lang.Object

com.valhalla.sdk.tasks.tree.Leaf

All Implemented Interfaces:

Sleepable

Direct Known Subclasses:

Branch

public abstract class Leaf
extends Object
implements Sleepable

Executable decision-tree node with access to its attached TreeScript.

Constructor Summary

Constructors

Constructor	Description
Leaf()

Method Summary

Modifier and Type	Method	Description
protected final ScriptContext	getContext()	Returns the context for the current tree loop.
final Branch	getParent()	Returns this node's parent.
TreeScript	getTree()	Returns the owning tree.
abstract boolean	isValid()	Tests whether this node is eligible for selection.
abstract long	onLoop()	Executes one unit of leaf work.
void	setParent(Branch value)	Attaches or detaches this node.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.valhalla.sdk.api.util.Sleepable

sleep, sleep, sleepUntil, sleepUntil, sleepUntil, sleepWhile, sleepWhile, sleepWhile

Constructor Details

Leaf

public Leaf()

Method Details

isValid

public abstract boolean isValid()

Tests whether this node is eligible for selection.

Returns:

true when this node should be selected in the current tree state

onLoop

public abstract long onLoop()

Executes one unit of leaf work.

Returns:

requested delay after one bounded unit of work; negative requests stop

getParent

public final Branch getParent()

Returns this node's parent.

Returns:

parent branch, or null while detached

setParent

public void setParent(Branch value)

Attaches or detaches this node.

Parameters:

value - parent branch, or null to detach

getTree

public TreeScript getTree()

Returns the owning tree.

Returns:

owning tree, or null while detached

getContext

protected final ScriptContext getContext()

Returns the context for the current tree loop.

Returns:

current script context

Throws:

IllegalStateException - when detached or evaluated outside a running tree loop