Module org.arakhne.afc.core.mathtree

Package org.arakhne.afc.math.tree.iterator

Class PrefixDepthFirstTreeIterator<N extends TreeNode<?,N>>

java.lang.Object

org.arakhne.afc.math.tree.iterator.AbstractPrefixDepthFirstTreeIterator<N,N>

org.arakhne.afc.math.tree.iterator.PrefixDepthFirstTreeIterator<N>

Type Parameters:

N - is the type of the tree nodes.

All Implemented Interfaces:

Iterator<N>, NodeSelectionTreeIterator<N>

public class PrefixDepthFirstTreeIterator<N extends TreeNode<?,N>>
extends AbstractPrefixDepthFirstTreeIterator<N,N>
implements NodeSelectionTreeIterator<N>

This class is an prefixed iterator on a tree. It treats the parent node before going inside the child nodes.

Since:

13.0

Version:

17.0 2020-01-04 14:41:41

Author:

Stéphane GALLAND

Maven Group Id:

org.arakhne.afc.core

Maven Artifact Id:

mathtree

Constructor Summary

Constructors

Constructor	Description
PrefixDepthFirstTreeIterator(N node)	Constructor.
PrefixDepthFirstTreeIterator(N node, NodeSelector<N> selector)	Constructor.
PrefixDepthFirstTreeIterator(Tree<?,N> tree)	Constructor.
PrefixDepthFirstTreeIterator(Tree<?,N> tree, NodeSelector<N> selector)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected boolean	isTraversableParent(N parent)	Replies if an object to type N which is corresponding to the given child node retreived from the given parent node.
void	setNodeSelector(NodeSelector<N> selector)	Set the node selector used by this iterator.
protected N	toTraversableChild(N parent, N child)	Replies an object to type N which is corresponding to the given child node retreived from the given parent node.

Methods inherited from class org.arakhne.afc.math.tree.iterator.AbstractPrefixDepthFirstTreeIterator

hasNext, next, remove

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, hasNext, next, remove

Constructor Detail

PrefixDepthFirstTreeIterator

public PrefixDepthFirstTreeIterator(Tree<?,N> tree)

Constructor.

Parameters:

tree - is the tree to iterate.

PrefixDepthFirstTreeIterator

public PrefixDepthFirstTreeIterator(Tree<?,N> tree,
                                    NodeSelector<N> selector)

Constructor.

Parameters:

tree - is the tree to iterate.

selector - permits to filter the nodes replied/traversed by this iterator.

PrefixDepthFirstTreeIterator

public PrefixDepthFirstTreeIterator(N node)

Constructor.

Parameters:

node - is the node to iterate.

PrefixDepthFirstTreeIterator

public PrefixDepthFirstTreeIterator(N node,
                                    NodeSelector<N> selector)

Constructor.

Parameters:

node - is the node to iterate.

selector - permits to filter the nodes replied/traversed by this iterator.

Method Detail

setNodeSelector

public void setNodeSelector(NodeSelector<N> selector)

Description copied from interface: NodeSelectionTreeIterator

Set the node selector used by this iterator.

Specified by:

setNodeSelector in interface NodeSelectionTreeIterator<N extends TreeNode<?,N>>

Parameters:

selector - permits to filter the nodes replied/tranversed by this iterator.

isTraversableParent

@Pure
protected boolean isTraversableParent(N parent)

Description copied from class: AbstractPrefixDepthFirstTreeIterator

Replies if an object to type N which is corresponding to the given child node retreived from the given parent node.

Specified by:

isTraversableParent in class AbstractPrefixDepthFirstTreeIterator<N extends TreeNode<?,N>,N extends TreeNode<?,N>>

Parameters:

parent - is the node from which the child node was retreived.

Returns:

true if the given node is traversable, false otherwise.

toTraversableChild

@Pure
protected N toTraversableChild(N parent,
                               N child)

Description copied from class: AbstractPrefixDepthFirstTreeIterator

Replies an object to type N which is corresponding to the given child node retreived from the given parent node.

Specified by:

toTraversableChild in class AbstractPrefixDepthFirstTreeIterator<N extends TreeNode<?,N>,N extends TreeNode<?,N>>

Parameters:

parent - is the node from which the child node was retreived.

child - is the child node to test.

Returns:

the traversable node, or null if the node is not traversable.