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 and Description
void	childAdd(JOTreeNodeType<A> child) Add a child to this node.
void	childRemove(JOTreeNodeType<A> child) Remove a child from this node.
Collection<JOTreeNodeType<A>>	children()
void	detach() Detach this node from its parent node.
Optional<JOTreeNodeType<A>>	parent()
void	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 Detail

detach

void detach()

Detach this node from its parent node.

children

Collection<JOTreeNodeType<A>> children()

Returns:

A read-only collection containing the children of this node

childRemove

void 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

childAdd

void 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

Throws:

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

setParent

void setParent(JOTreeNodeType<A> new_parent)
        throws JOTreeExceptionCycle

Set this node's parent to new_parent.

Parameters:

new_parent - The new parent node

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