Package de.xima.fc.common.workflow

Enum ETreeAccessorWorkflowNode

java.lang.Object

java.lang.Enum<ETreeAccessorWorkflowNode>

de.xima.fc.common.workflow.ETreeAccessorWorkflowNode

All Implemented Interfaces:

ITreeAccessor<WorkflowNode,UUID>, ITreeParentAccessor<WorkflowNode,UUID>, Serializable, Comparable<ETreeAccessorWorkflowNode>

public enum ETreeAccessorWorkflowNode
extends Enum<ETreeAccessorWorkflowNode>
implements ITreeAccessor<WorkflowNode,UUID>, ITreeParentAccessor<WorkflowNode,UUID>

A ITreeAccessor for treating WorkflowNodes as a tree, so that they can be used with the execution analyzer.

Since:

8.4.0

Author:

XIMA MEDIA GmbH

Enum Constant Summary

Enum Constants

Enum Constant	Description
INSTANCE	The immutable singleton instance of this accessor.
WORKFLOW_NODE_TREE_ACCESSOR	The immutable singleton instance of this accessor.

Method Summary

Modifier and Type	Method	Description
List<WorkflowNode>	getChildren(WorkflowNode node)	Gets the children of the given node.
UUID	getId(WorkflowNode node)	Gets the ID of the given node.
WorkflowNode	getParent(WorkflowNode node)
static ETreeAccessorWorkflowNode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ETreeAccessorWorkflowNode[]	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

INSTANCE

public static final ETreeAccessorWorkflowNode INSTANCE

The immutable singleton instance of this accessor.

WORKFLOW_NODE_TREE_ACCESSOR

public static final ETreeAccessorWorkflowNode WORKFLOW_NODE_TREE_ACCESSOR

The immutable singleton instance of this accessor.

Method Detail

values

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

Returns:

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

valueOf

public static ETreeAccessorWorkflowNode 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

getChildren

public List<WorkflowNode> getChildren(WorkflowNode node)

Description copied from interface: ITreeAccessor

Gets the children of the given node. It is generally recommended to return a list of nodes for fast random access, but implementations must be compatible with general iterables.

Specified by:

getChildren in interface ITreeAccessor<WorkflowNode,UUID>

Parameters:

node - The node for which to get the children.

Returns:

A list of all children of the given tree node, empty array if it is a leaf node.

getId

public UUID getId(WorkflowNode node)

Description copied from interface: ITreeAccessor

Gets the ID of the given node. The ID must be unique within the tree, but it is not required to be unique across different trees.

Specified by:

getId in interface ITreeAccessor<WorkflowNode,UUID>

Specified by:

getId in interface ITreeParentAccessor<WorkflowNode,UUID>

Parameters:

node - A node for which to retrieve its ID.

Returns:

The (unique) identifier of the given tree node.

getParent

public WorkflowNode getParent(WorkflowNode node)

Specified by:

getParent in interface ITreeParentAccessor<WorkflowNode,UUID>

Parameters:

node - The node for which to get the parent.

Returns:

Parent of the node, null if it is a root node.