java.lang.Object

com.io7m.jorchard.core.JOTreeNode<A>

Type Parameters:: A - The type of values contained within the tree

All Implemented Interfaces:: JOTreeNodeReadableType<A>, JOTreeNodeType<A>

public final class JOTreeNode<A> extends Object implements JOTreeNodeType<A>

The default implementation of the JOTreeNodeType type.

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()

List<JOTreeNodeReadableType<A>>

childrenReadable()

void

childrenSortNodes(Comparator<JOTreeNodeType<A>> comparator)

Sort the children of this node.

static <A> JOTreeNodeType<A>

create(A in_value)

Create a new node with the given value.

static <A> JOTreeNodeType<A>

createWithDetachCheck(A in_value, BooleanSupplier in_detach_check)

Create a new node with the given value.

JOTreeNodeType<A>

detach()

Detach this node from its parent node.

<T> void

forEachBreadthFirst(T context, JOTreeNodeForEachFunctionType<A,T> f)

Visit each node in the tree in breadth-first order.

<T> void

forEachDepthFirst(T context, JOTreeNodeForEachFunctionType<A,T> f)

Visit each node in the tree in depth-first order.

boolean

isDescendantOf(JOTreeNodeReadableType<A> other)

boolean

isDetachAllowed()

<T, B> JOTreeNodeType<B>

mapBreadthFirst(T context, JOTreeNodeMapFunctionType<A,T,B> f)

Visit each node in the tree in breadth-first order.

<T, B> JOTreeNodeType<B>

mapDepthFirst(T context, JOTreeNodeMapFunctionType<A,T,B> f)

Visit each node in the tree in depth-first order.

Optional<JOTreeNodeType<A>>

parent()

Optional<JOTreeNodeReadableType<A>>

parentReadable()

JOTreeNodeType<A>

setParent(JOTreeNodeType<A> parent_new)

Set this node's parent to new_parent.

String

toString()

A

value()

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

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

Methods inherited from interface com.io7m.jorchard.core.JOTreeNodeType
childrenSort

Method Details
- create
  
  public static <A> JOTreeNodeType<A> create(A in_value)
  
  Create a new node with the given value. The node has no parent and no children.
  
  Type Parameters:
  
  A - The type of values
  
  Parameters:
  
  in_value - The value
  
  Returns:
  
  A new node
- createWithDetachCheck
  
  public static <A> JOTreeNodeType<A> createWithDetachCheck(A in_value, BooleanSupplier in_detach_check)
  
  Create a new node with the given value. The node has no parent and no children. The node is equipped with a function that is evaluated each before the node is detached from any node, with a true value indicating that the node is allowed to be detached.
  
  Type Parameters:
  
  A - The type of values
  
  Parameters:
  
  in_value - The value
  
  in_detach_check - A detach check function
  
  Returns:
  
  A new node
- isDetachAllowed
  
  public boolean isDetachAllowed()
  
  Specified by:
  
  isDetachAllowed in interface JOTreeNodeReadableType<A>
  
  Returns:
  
  true iff this node may be detached from its parent
- value
  
  public A value()
  
  Specified by:
  
  value in interface JOTreeNodeReadableType<A>
  
  Returns:
  
  The value contained within the node
- parentReadable
  
  public Optional<JOTreeNodeReadableType<A>> parentReadable()
  
  Specified by:
  
  parentReadable in interface JOTreeNodeReadableType<A>
  
  Returns:
  
  A readable reference to the parent node
- childrenReadable
  
  public List<JOTreeNodeReadableType<A>> childrenReadable()
  
  Specified by:
  
  childrenReadable in interface JOTreeNodeReadableType<A>
  
  Returns:
  
  A read-only collection containing the children of this node
- toString
  
  public String toString()
  
  Overrides:
  
  toString in class Object
- setParent
  
  public JOTreeNodeType<A> setParent(JOTreeNodeType<A> parent_new)
  
  Description copied from interface: JOTreeNodeType
  
  Set this node's parent to new_parent.
  
  Specified by:
  
  setParent in interface JOTreeNodeType<A>
  
  Parameters:
  
  parent_new - The new parent node
  
  Returns:
  
  this
- parent
  
  public Optional<JOTreeNodeType<A>> parent()
  
  Specified by:
  
  parent in interface JOTreeNodeType<A>
  
  Returns:
  
  A reference to the parent node, if any
- childrenSortNodes
  
  public void childrenSortNodes(Comparator<JOTreeNodeType<A>> comparator)
  
  Description copied from interface: JOTreeNodeType
  
  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 JOTreeNodeType.children().
  
  Specified by:
  
  childrenSortNodes in interface JOTreeNodeType<A>
  
  Parameters:
  
  comparator - A node comparator
- detach
  
  public JOTreeNodeType<A> detach()
  
  Description copied from interface: JOTreeNodeType
  
  Detach this node from its parent node.
  
  Specified by:
  
  detach in interface JOTreeNodeType<A>
  
  Returns:
  
  this
- children
  
  public List<JOTreeNodeType<A>> children()
  
  Specified by:
  
  children in interface JOTreeNodeType<A>
  
  Returns:
  
  A read-only collection containing the children of this node
- childRemove
  
  public JOTreeNodeType<A> childRemove(JOTreeNodeType<A> child)
  
  Description copied from interface: JOTreeNodeType
  
  Remove a child from this node. Has no effect if the given node is not a child of this node.
  
  Specified by:
  
  childRemove in interface JOTreeNodeType<A>
  
  Parameters:
  
  child - A child node
  
  Returns:
  
  this
- childAdd
  
  public JOTreeNodeType<A> childAdd(JOTreeNodeType<A> child)
  
  Description copied from interface: JOTreeNodeType
  
  Add a child to this node. Has no effect if the given node is already a child of this node.
  
  Specified by:
  
  childAdd in interface JOTreeNodeType<A>
  
  Parameters:
  
  child - A child node
  
  Returns:
  
  this
- isDescendantOf
  
  public boolean isDescendantOf(JOTreeNodeReadableType<A> other)
  
  Specified by:
  
  isDescendantOf in interface JOTreeNodeReadableType<A>
  
  Parameters:
  
  other - A node
  
  Returns:
  
  true iff this node is a descendant of other
- forEachDepthFirst
  
  public <T> void forEachDepthFirst(T context, JOTreeNodeForEachFunctionType<A,T> f)
  
  Description copied from interface: JOTreeNodeReadableType
  
  Visit each node in the tree in depth-first order.
  
  The function allows for the use of a context value. This is useful for avoiding the use of capturing lambdas, reducing GC pressure.
  
  Specified by:
  
  forEachDepthFirst in interface JOTreeNodeReadableType<A>
  
  Type Parameters:
  
  T - The type of context values
  
  Parameters:
  
  context - A context value passed to each application of f
  
  f - A function used to receive each node
- forEachBreadthFirst
  
  public <T> void forEachBreadthFirst(T context, JOTreeNodeForEachFunctionType<A,T> f)
  
  Description copied from interface: JOTreeNodeReadableType
  
  Visit each node in the tree in breadth-first order.
  
  The function allows for the use of a context value. This is useful for avoiding the use of capturing lambdas, reducing GC pressure.
  
  Specified by:
  
  forEachBreadthFirst in interface JOTreeNodeReadableType<A>
  
  Type Parameters:
  
  T - The type of context values
  
  Parameters:
  
  context - A context value passed to each application of f
  
  f - A function used to receive each node
- mapDepthFirst
  
  public <T, B> JOTreeNodeType<B> mapDepthFirst(T context, JOTreeNodeMapFunctionType<A,T,B> f)
  
  Description copied from interface: JOTreeNodeReadableType
  
  Visit each node in the tree in depth-first order.
  
  The function allows for the use of a context value. This is useful for avoiding the use of capturing lambdas, reducing GC pressure.
  
  Specified by:
  
  mapDepthFirst in interface JOTreeNodeReadableType<A>
  
  Type Parameters:
  
  T - The type of context values
  
  B - The type of values in the returned tree
  
  Parameters:
  
  context - A context value passed to each application of f
  
  f - A function used to receive each node
  
  Returns:
  
  A new structurally equal tree with nodes of type B
- mapBreadthFirst
  
  public <T, B> JOTreeNodeType<B> mapBreadthFirst(T context, JOTreeNodeMapFunctionType<A,T,B> f)
  
  Description copied from interface: JOTreeNodeReadableType
  
  Visit each node in the tree in breadth-first order.
  
  The function allows for the use of a context value. This is useful for avoiding the use of capturing lambdas, reducing GC pressure.
  
  Specified by:
  
  mapBreadthFirst in interface JOTreeNodeReadableType<A>
  
  Type Parameters:
  
  T - The type of context values
  
  B - The type of values in the returned tree
  
  Parameters:
  
  context - A context value passed to each application of f
  
  f - A function used to receive each node
  
  Returns:
  
  A new structurally equal tree with nodes of type B

Class JOTreeNode<A>

Method Summary

Methods inherited from class java.lang.Object

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

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

Method Details

create

createWithDetachCheck

isDetachAllowed

value

parentReadable

childrenReadable

toString

setParent

parent

childrenSortNodes

detach

children

childRemove

childAdd

isDescendantOf

forEachDepthFirst

forEachBreadthFirst

mapDepthFirst

mapBreadthFirst