com.levigo.jadice.demo.outline

Class OutlineNodes

java.lang.Object

com.levigo.jadice.demo.outline.OutlineNodes

public final class OutlineNodes
extends Object

A collection of static utility methods to be used in conjunction with OutlineNodes.

Method Summary

Modifier and Type	Method and Description
static <N extends OutlineNode<N>> N	findLastDescendant(N n) Return the last descendant of this node in traversal order.
static <N extends OutlineNode<N>> N	findNext(N n) Find the next OutlineNode in a depth-first traversal order of the node tree.
static <N extends OutlineNode<N>> N	findNext(N n, boolean descend, boolean ascend) Find the next OutlineNode in a depth-first traversal order of the node tree.
static <N extends OutlineNode<N>> N	findPrevious(N n) Find the previous OutlineNode in a depth-first traversal order of the node tree.
static <N extends OutlineNode<N>> N	findPrevious(N n, boolean descend, boolean ascend) Find the previous OutlineNode in a depth-first traversal order of the node tree.
static void	visit(OutlineNode<?> node, OutlineVisitor visitor) Starts the visiting process for the given OutlineVisitor and node.

Methods inherited from class java.lang.Object

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

Method Detail

findNext

public static <N extends OutlineNode<N>> N findNext(N n)

Find the next OutlineNode in a depth-first traversal order of the node tree. The rules of the traversal are as follows:

• if the given node has children, its first child is chosen
• else if the given node has siblings and is not the last among its siblings the following sibling is chosen
• else if the given node has a parent, the selection re-starts at the parent
• else null is returned, indicating that there is no next node

Parameters:

n - the node from which to start

Returns:

the next node or null if there is no next node

findNext

public static <N extends OutlineNode<N>> N findNext(N n,
                                                    boolean descend,
                                                    boolean ascend)

Find the next OutlineNode in a depth-first traversal order of the node tree. Two flags control the traversal:

descend

if descend is true and the given node has children, the first child of n is selected as the next node

ascend

if ascend is true and the given node has neither children nor a next sibling but a parent, the parent of n is selected as the next node

Parameters:

n - the node from which to start

descend - whether to descend in the tree looking for the next node

ascend - whether to ascend in the tree looking for the next node

Returns:

the next node or null if there is no next node

findPrevious

public static <N extends OutlineNode<N>> N findPrevious(N n)

Find the previous OutlineNode in a depth-first traversal order of the node tree. The rules of the traversal are as follows:

• if the given node has siblings and is not the first among its siblings the preceding sibling last descendant (in traversal order) is chosen
• else if the given node has a parent, the selection re-starts at the parent
• else null is returned, indicating that there is no next node

Returns:

the preceding node or null if there is no next node

findPrevious

public static <N extends OutlineNode<N>> N findPrevious(N n,
                                                        boolean descend,
                                                        boolean ascend)

Find the previous OutlineNode in a depth-first traversal order of the node tree. The ascend-flag controls the traversal: if ascend is true and the given node does not have a preceding sibling but a parent, the parent of n is selected as the next node

Parameters:

ascend - whether to ascend in the tree looking for the next node

Returns:

the next node or null if there is no next node

findLastDescendant

public static <N extends OutlineNode<N>> N findLastDescendant(N n)

Return the last descendant of this node in traversal order. If this node does not have a descendant, return the node itself.

Returns:

the last descendant

visit

public static void visit(OutlineNode<?> node,
                         OutlineVisitor visitor)

Starts the visiting process for the given OutlineVisitor and node. The visitor can control the traversal process by returning the appropriate OutlineVisitor.VisitResults for each node it visits.

Parameters:

node - the node/outline

visitor - the visitor