FlatTreeNode (Jenetics 3.9.0)

java.lang.Object
- org.jenetics.ext.util.FlatTreeNode<T>

All Implemented Interfaces:

Iterable<FlatTreeNode<T>>, FlatTree<T,FlatTreeNode<T>>, Tree<T,FlatTreeNode<T>>
```
public final class FlatTreeNode<T>
extends Object
implements FlatTree<T,FlatTreeNode<T>>
```
Default implementation of the FlatTree interface.

Since:

3.9

Version:

3.9

Author:

Franz Wilhelmstötter

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`childCount()` Return the number of children this tree node consists of.
`int`	`childOffset()` Return the index of the first child node in the underlying node array.
`boolean`	`equals(Object obj)`
`ISeq<FlatTreeNode<T>>`	`flattenedNodes()` Return the whole flattened tree values in breadth-first order.
`FlatTreeNode<T>`	`getChild(int index)` Return the child node with the given index.
`Optional<FlatTreeNode<T>>`	`getParent()` Return the parent node of this tree node.
`FlatTreeNode<T>`	`getRoot()` Returns the root of the tree that contains this node.
`T`	`getValue()` Return the value of the current `Tree` node.
`int`	`hashCode()`
`boolean`	`identical(Tree<?,?> other)` Tests whether `this` node is the same as the `other` node.
`boolean`	`isRoot()` Returns `true` if this node is the root of the tree.
`<B> ISeq<B>`	`map(Function<FlatTreeNode<T>,? extends B> mapper)` Return a sequence of all mapped nodes of the whole underlying tree.
`static <V> FlatTreeNode<V>`	`of(Tree<? extends V,?> tree)` Create a new `FlatTreeNode` from the given `tree`.
`Stream<FlatTreeNode<T>>`	`stream()` Return a stream of all nodes of the whole underlying tree.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jenetics.ext.util.Tree
breadthFirstIterator, breadthFirstStream, childAfter, childBefore, childIterator, childStream, depth, depthFirstIterator, depthFirstStream, equals, firstChild, firstLeaf, getIndex, getPath, hashCode, isAncestor, isChild, isDescendant, isLeaf, isRelated, isSibling, iterator, lastChild, lastLeaf, leafCount, level, nextLeaf, nextNode, nextSibling, pathFromAncestorIterator, postorderIterator, postorderStream, preorderIterator, preorderStream, previousLeaf, previousNode, previousSibling, sharedAncestor, siblingCount, size, toCompactString, toDottyString, toString

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Method Detail
  - getRoot
```
public FlatTreeNode<T> getRoot()
```
    Returns the root of the tree that contains this node. The root is the ancestor with no parent. This implementation have a runtime complexity of O(1).
    
    Specified by:
    
    getRoot in interface Tree<T,FlatTreeNode<T>>
    
    Returns:
    
    the root of the tree that contains this node
  - isRoot
```
public boolean isRoot()
```
    Description copied from interface: Tree
    
    Returns true if this node is the root of the tree.
    
    Specified by:
    
    isRoot in interface Tree<T,FlatTreeNode<T>>
    
    Returns:
    
    true if this node is the root of its tree, false otherwise
  - getValue
```
public T getValue()
```
    Description copied from interface: Tree
    
    Return the value of the current Tree node. The value my be null.
    
    Specified by:
    
    getValue in interface Tree<T,FlatTreeNode<T>>
    
    Returns:
    
    the value of the current Tree node
  - getParent
```
public Optional<FlatTreeNode<T>> getParent()
```
    Description copied from interface: Tree
    
    Return the parent node of this tree node.
    
    Specified by:
    
    getParent in interface Tree<T,FlatTreeNode<T>>
    
    Returns:
    
    the parent node, or Optional.empty() if this node is the root of the tree
  - getChild
```
public FlatTreeNode<T> getChild(int index)
```
    Description copied from interface: Tree
    
    Return the child node with the given index.
    
    Specified by:
    
    getChild in interface Tree<T,FlatTreeNode<T>>
    
    Parameters:
    
    index - the child index
    
    Returns:
    
    the child node with the given index
  - childCount
```
public int childCount()
```
    Description copied from interface: Tree
    
    Return the number of children this tree node consists of.
    
    Specified by:
    
    childCount in interface Tree<T,FlatTreeNode<T>>
    
    Returns:
    
    the number of children this tree node consists of
  - childOffset
```
public int childOffset()
```
    Return the index of the first child node in the underlying node array. -1 is returned if this node is a leaf.
    
    Specified by:
    
    childOffset in interface FlatTree<T,FlatTreeNode<T>>
    
    Returns:
    
    Return the index of the first child node in the underlying node array, or -1 if this node is a leaf
  - flattenedNodes
```
public ISeq<FlatTreeNode<T>> flattenedNodes()
```
    Description copied from interface: FlatTree
    
    Return the whole flattened tree values in breadth-first order. This is equivalent to
    final ISeq<T> seq = getRoot().breadthFirstStream() .collect(ISeq.toISeq());
    
    Specified by:
    
    flattenedNodes in interface FlatTree<T,FlatTreeNode<T>>
    
    Returns:
    
    the flattened tree values in breadth-first order
  - stream
```
public Stream<FlatTreeNode<T>> stream()
```
    Return a stream of all nodes of the whole underlying tree. This method call is equivalent to
    final Stream<FlatTreeNode<T>> nodes = getRoot().breadthFirstStream();
    
    Specified by:
    
    stream in interface Tree<T,FlatTreeNode<T>>
    
    Returns:
    
    a stream of all nodes of the whole underlying tree
    
    See Also:
    
    Tree.breadthFirstStream()
  - map
```
public <B> ISeq<B> map(Function<FlatTreeNode<T>,? extends B> mapper)
```
    Return a sequence of all mapped nodes of the whole underlying tree. This is a convenient method for
    final ISeq<B> seq = stream() .map(mapper) .collect(ISeq.toISeq())
    
    Type Parameters:
    
    B - the mapped type
    
    Parameters:
    
    mapper - the mapper function
    
    Returns:
    
    a sequence of all mapped nodes
  - identical
```
public boolean identical(Tree<?,?> other)
```
    Description copied from interface: Tree
    
    Tests whether this node is the same as the other node. The default implementation returns the object identity, this == other, of the two objects, but other implementations may use different criteria for checking the identity.
    
    Specified by:
    
    identical in interface Tree<T,FlatTreeNode<T>>
    
    Parameters:
    
    other - the other node
    
    Returns:
    
    true if the other node is the same as this node.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - of
```
public static <V> FlatTreeNode<V> of(Tree<? extends V,?> tree)
```
    Create a new FlatTreeNode from the given tree.
    
    Type Parameters:
    
    V - the tree value types
    
    Parameters:
    
    tree - the source tree
    
    Returns:
    
    a new FlatTreeNode from the given tree
    
    Throws:
    
    NullPointerException - if the given tree is null

Class FlatTreeNode<T>

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.jenetics.ext.util.Tree

Methods inherited from interface java.lang.Iterable

Method Detail

getRoot

isRoot

getValue

getParent

getChild

childCount

childOffset

flattenedNodes

stream

map

identical

hashCode

equals

toString

of