org.vishia.fbcl.fblock

Class EvtreeNode_FBcl.IteratorEvoutTree

java.lang.Object

org.vishia.fbcl.fblock.EvtreeNode_FBcl.IteratorEvoutTree

All Implemented Interfaces:

java.lang.Iterable<EvtreeNode_FBcl>, java.util.Iterator<EvtreeNode_FBcl>

Enclosing class:

EvtreeNode_FBcl

public static class EvtreeNode_FBcl.IteratorEvoutTree
extends java.lang.Object
implements java.lang.Iterable<EvtreeNode_FBcl>, java.util.Iterator<EvtreeNode_FBcl>

It is an Iterator for the tree for all EvtreeNode_FBcl.nodes starting from the given node as root. It is offered also as Iterable: A normal LinkedList etc. is also an Iterable. Whereas an Iterator is a specific instance with some data for iteration. This class is immediately the Iterator instance. A for statement needs first an Iterable which is also given with this class. See iterator().

Field Summary

Fields

Modifier and Type	Field and Description
(package private) boolean	bHasNextDone
(package private) EvtreeNode_FBcl	currNode
(package private) java.util.ListIterator<EvtreeNode_FBcl>	iterCurrNode
(package private) java.util.Stack<java.util.ListIterator<EvtreeNode_FBcl>>	stackIter

Constructor Summary

Constructors

Constructor and Description
IteratorEvoutTree(EvtreeNode_FBcl rootNode, boolean bAlsoRootNode) Creates the iterator from the given rootNode

Method Summary

Modifier and Type	Method and Description
EvtreeNode_FBcl	getNextSibling() Sets the iterator to the next sibling in the tree and returns this sibling for test.
EvtreeNode_FBcl	getSibling() Specific operation to get the sibling of that node, which is last returned by next() respectively which is current after hasNext().
boolean	hasNext() Standard quest, see Iterator.hasNext()
java.util.Iterator<EvtreeNode_FBcl>	iterator() Returns this as Iterator if this is presented as Iterable.
EvtreeNode_FBcl	next()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Field Detail

currNode

EvtreeNode_FBcl currNode

iterCurrNode

java.util.ListIterator<EvtreeNode_FBcl> iterCurrNode

stackIter

java.util.Stack<java.util.ListIterator<EvtreeNode_FBcl>> stackIter

bHasNextDone

boolean bHasNextDone

Constructor Detail

IteratorEvoutTree

public IteratorEvoutTree(EvtreeNode_FBcl rootNode,
                         boolean bAlsoRootNode)

Creates the iterator from the given rootNode

Parameters:

rootNode -

bAlsoRootNode - returns also the rootNode itself as first for iteration.

Method Detail

iterator

public java.util.Iterator<EvtreeNode_FBcl> iterator()

Returns this as Iterator if this is presented as Iterable. Note: An Iterable has exact only this operation.

Specified by:

iterator in interface java.lang.Iterable<EvtreeNode_FBcl>

hasNext

public boolean hasNext()

Standard quest, see Iterator.hasNext()

Specified by:

hasNext in interface java.util.Iterator<EvtreeNode_FBcl>

next

public EvtreeNode_FBcl next()

Specified by:

next in interface java.util.Iterator<EvtreeNode_FBcl>

getSibling

public EvtreeNode_FBcl getSibling()

Specific operation to get the sibling of that node, which is last returned by next() respectively which is current after hasNext(). It uses the internal iterCurrNode in the last stackIter level to get the next EvTreeNode_FBcl#nodes as sibling, but restore the iterator to the point before after them so that the normal iteration is restored, not disturbed.

Returns:

null if there is no sibling.

getNextSibling

public EvtreeNode_FBcl getNextSibling()

Sets the iterator to the next sibling in the tree and returns this sibling for test. hasNext() can be called or not, next() delivers this next sibling.

Returns:

the sibling as also returned by next() or null if it has not a next sibling