org.mdiutil.tree

Class TreeIterator

java.lang.Object

org.mdiutil.tree.TreeIterator

All Implemented Interfaces:

Iterator<TreeNode>

public class TreeIterator
extends Object
implements Iterator<TreeNode>

This class iterates through a tree, beginning with a first TreeNode ancestor.

Field Summary

Fields

Modifier and Type	Field and Description
protected TreeNode	curnode
static int	MODE_AFTER_ROOT
static int	MODE_UNDER_ROOT
protected TreeNode	rootnode
protected Stack<TreeNode>	stack

Constructor Summary

Constructors

Constructor and Description
TreeIterator(TreeNode rootnode) Constructor.
TreeIterator(TreeNode rootnode, int mode) Constructor.

Method Summary

Modifier and Type	Method and Description
static TreeNode	firstChild(TreeNode node) Return the first child node of a TreeNode.
int	getLevel() Return the current level of this iterator.
boolean	hasNext() Return true if there is a node after the current one.
static boolean	hasSibling(TreeNode node) Return true if a Node has at least one sibling.
TreeNode	next() This method only performs a call to nextNode();
TreeNode	nextNode() Retrieve the next node in the tree.
static TreeNode	nextSibling(TreeNode node) Return the next sibling node for a TreeNode.
void	remove() This method is not supported by this iterator.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining

Field Detail

MODE_UNDER_ROOT

public static final int MODE_UNDER_ROOT

See Also:

Constant Field Values

MODE_AFTER_ROOT

public static final int MODE_AFTER_ROOT

See Also:

Constant Field Values

stack

protected Stack<TreeNode> stack

curnode

protected TreeNode curnode

rootnode

protected TreeNode rootnode

Constructor Detail

TreeIterator

public TreeIterator(TreeNode rootnode,
                    int mode)

Constructor.

Parameters:

rootnode - the node where the iteration begins

mode - the mode

TreeIterator

public TreeIterator(TreeNode rootnode)

Constructor.

Parameters:

rootnode - the node where the iteration begins

Method Detail

hasNext

public boolean hasNext()

Return true if there is a node after the current one. It is considered that there is a next node after the current one if:

• if there is at least one child, then there is a next node
• else if the mode is MODE_AFTER_ROOT :
• if there is no parent, there is no next node
• else there is at least one next node
• else if the mode is MODE_UNDER_ROOT :
• if there is no parent, there is no next node
• else if the parent is the same as the parent of root node there is no next node
• else there is at least one next node

Specified by:

hasNext in interface Iterator<TreeNode>

Returns:

true if there is a node after the current one

next

public TreeNode next()

This method only performs a call to nextNode();

Specified by:

next in interface Iterator<TreeNode>

getLevel

public int getLevel()

Return the current level of this iterator. The level 0 is the initial node.

Returns:

the current level of this iterator

remove

public void remove()

This method is not supported by this iterator.

Specified by:

remove in interface Iterator<TreeNode>

nextNode

public TreeNode nextNode()

Retrieve the next node in the tree. If there is no next node, returns null.

Returns:

the next Node

firstChild

public static final TreeNode firstChild(TreeNode node)

Return the first child node of a TreeNode.

Parameters:

node - the Node

Returns:

the first child node

nextSibling

public static final TreeNode nextSibling(TreeNode node)

Return the next sibling node for a TreeNode.

Parameters:

node - the Node

Returns:

the next sibling, or null if there is no next sibling

hasSibling

public static final boolean hasSibling(TreeNode node)

Return true if a Node has at least one sibling.

Parameters:

node - the Node

Returns:

true if the Node has at least one sibling