nova.core.util.collection

Class TreeNode<S extends TreeNode<S>>

java.lang.Object

nova.core.util.collection.TreeNode<S>

Type Parameters:

S - - Self type

All Implemented Interfaces:

java.lang.Iterable<S>

Direct Known Subclasses:

Model

public class TreeNode<S extends TreeNode<S>>
extends java.lang.Object
implements java.lang.Iterable<S>

A node inside of a tree structure.

Field Summary

Fields

Modifier and Type	Field and Description
java.util.Set<S>	children The children of the node.
protected java.util.Optional<S>	parent The parent of the node.

Constructor Summary

Constructors

Constructor and Description
TreeNode()

Method Summary

Modifier and Type	Method and Description
S	addChild(S node) Adds a childnode to the node
java.util.Set<S>	children() Get the direct childnodes
java.util.Set<S>	descendants() Gets all child nodes recursively
boolean	exists(S targetChild) Checks recursively to see if any of the children can match the given child.
java.util.Optional<S>	getParent() The parrent of this node
java.util.List<S>	hierarchy()
java.util.Iterator<S>	iterator()
S	removeChild(S child) Remove a childnode
void	setParent(java.util.Optional<S> parent) Set's the parrent of this node
java.util.Spliterator<S>	spliterator()
java.util.stream.Stream<S>	stream()

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

Field Detail

children

public final java.util.Set<S extends TreeNode<S>> children

The children of the node.

parent

protected java.util.Optional<S extends TreeNode<S>> parent

The parent of the node. The root node has no parent.

Constructor Detail

TreeNode

public TreeNode()

Method Detail

getParent

public java.util.Optional<S> getParent()

The parrent of this node

Returns:

The parrent of this node if there is one, otherwise Optional.empty

setParent

public void setParent(java.util.Optional<S> parent)

Set's the parrent of this node

Parameters:

parent - The new parrent of this node

addChild

public S addChild(S node)

Adds a childnode to the node

Parameters:

node - The childnode to add

Returns:

The merged node

removeChild

public S removeChild(S child)

Remove a childnode

Parameters:

child - The childnode to remove

Returns:

This

children

public java.util.Set<S> children()

Get the direct childnodes

Returns:

A set containing the direct childnodes

descendants

public java.util.Set<S> descendants()

Gets all child nodes recursively

Returns:

A set containing all child nodes and their descendants

exists

public boolean exists(S targetChild)

Checks recursively to see if any of the children can match the given child.

Parameters:

targetChild - - The target match to find.

Returns:

True if the tree structure contains the targetPerm.

hierarchy

public java.util.List<S> hierarchy()

Returns:

Gets the hierarchy of the tree ordered from the root node to the current node.

stream

public java.util.stream.Stream<S> stream()

iterator

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

Specified by:

iterator in interface java.lang.Iterable<S extends TreeNode<S>>

spliterator

public java.util.Spliterator<S> spliterator()

Specified by:

spliterator in interface java.lang.Iterable<S extends TreeNode<S>>