Package com.io7m.jorchard.core

Interface JOTreeNodeType<A>

Type Parameters:

A - The type of contained values.

All Superinterfaces:

JOTreeNodeReadableType<A>

All Known Implementing Classes:

JOTreeNode

public interface JOTreeNodeType<A>
extends JOTreeNodeReadableType<A>

The type of tree nodes.

Method Summary

Modifier and Type	Method	Description
JOTreeNodeType<A>	childAdd(JOTreeNodeType<A> child)	Add a child to this node.
JOTreeNodeType<A>	childRemove(JOTreeNodeType<A> child)	Remove a child from this node.
List<JOTreeNodeType<A>>	children()
default void	childrenSort(Comparator<A> comparator)	Sort the children of this node.
void	childrenSortNodes(Comparator<JOTreeNodeType<A>> comparator)	Sort the children of this node.
JOTreeNodeType<A>	detach()	Detach this node from its parent node.
Optional<JOTreeNodeType<A>>	parent()
JOTreeNodeType<A>	setParent(JOTreeNodeType<A> new_parent)	Set this node's parent to new_parent.

Methods inherited from interface com.io7m.jorchard.core.JOTreeNodeReadableType

childrenReadable, forEachBreadthFirst, forEachDepthFirst, isDescendantOf, isDetachAllowed, isRoot, mapBreadthFirst, mapDepthFirst, parentReadable, value

Method Details

detach

JOTreeNodeType<A> detach()

Detach this node from its parent node.

Returns:

this

children

List<JOTreeNodeType<A>> children()

Returns:

A read-only collection containing the children of this node

childRemove

JOTreeNodeType<A> childRemove(JOTreeNodeType<A> child)

Remove a child from this node. Has no effect if the given node is not a child of this node.

Parameters:

child - A child node

Returns:

this

childAdd

JOTreeNodeType<A> childAdd(JOTreeNodeType<A> child)
                    throws JOTreeExceptionCycle

Add a child to this node. Has no effect if the given node is already a child of this node.

Parameters:

child - A child node

Returns:

this

Throws:

JOTreeExceptionCycle - Iff adding the child would introduce a cycle in the tree

setParent

JOTreeNodeType<A> setParent(JOTreeNodeType<A> new_parent)
                     throws JOTreeExceptionCycle

Set this node's parent to new_parent.

Parameters:

new_parent - The new parent node

Returns:

this

Throws:

JOTreeExceptionCycle - Iff setting the parent would introduce a cycle in the tree

parent

Optional<JOTreeNodeType<A>> parent()

Returns:

A reference to the parent node, if any

childrenSortNodes

void childrenSortNodes(Comparator<JOTreeNodeType<A>> comparator)

Sort the children of this node. This will affect subsequent calls to JOTreeNodeReadableType.forEachDepthFirst(Object, JOTreeNodeForEachFunctionType) and JOTreeNodeReadableType.forEachBreadthFirst(Object, JOTreeNodeForEachFunctionType), and will affect the order of children().

Parameters:

comparator - A node comparator

childrenSort

default void childrenSort(Comparator<A> comparator)

Sort the children of this node. This will affect subsequent calls to JOTreeNodeReadableType.forEachDepthFirst(Object, JOTreeNodeForEachFunctionType) and JOTreeNodeReadableType.forEachBreadthFirst(Object, JOTreeNodeForEachFunctionType), and will affect the order of children().

Parameters:

comparator - A node comparator