org.macroing.cit.java.util.node.tree

Class AbstractTree

java.lang.Object

org.macroing.cit.java.util.node.tree.AbstractTree

All Implemented Interfaces:

Node, Tree

Direct Known Subclasses:

SimpleTree

public abstract class AbstractTree
extends java.lang.Object
implements Tree

An abstract Tree implementation that enhances accept(NodeHierarchicalVisitor) so that it accepts multiple child Nodes.

Since:

1.0.0

Author:

Jörgen Lundgren

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractTree.AbstractBuilder<T extends Node> An abstract Builder implementation that implements most methods, so you don't have to do it yourself.

Nested classes/interfaces inherited from interface org.macroing.cit.java.util.node.tree.Tree

Tree.Builder<T extends Node>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractTree(AbstractTree.AbstractBuilder<?> abstractBuilder) Constructs a new AbstractTree instance.

Method Summary

Modifier and Type	Method and Description
boolean	accept(NodeHierarchicalVisitor nodeHierarchicalVisitor) Accepts a NodeHierarchicalVisitor.
java.util.List<Node>	getNodes() Returns the Nodes currently added to this AbstractTree.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.macroing.cit.java.util.node.Node

accept

Constructor Detail

AbstractTree

protected AbstractTree(AbstractTree.AbstractBuilder<?> abstractBuilder)

Constructs a new AbstractTree instance.

If abstractBuilder is null, a NullPointerException will be thrown.

Parameters:

abstractBuilder - an AbstractTree.AbstractBuilder used in the building process

Throws:

java.lang.NullPointerException - thrown if, and only if, abstractBuilder is null

Method Detail

accept

public boolean accept(NodeHierarchicalVisitor nodeHierarchicalVisitor)

Accepts a NodeHierarchicalVisitor.

Returns the result of nodeHierarchicalVisitor.visitLeave(this).

If nodeHierarchicalVisitor is null, a NullPointerException will be thrown.

If a RuntimeException is thrown by the current NodeHierarchicalVisitor, a NodeTraversalException will be thrown with the RuntimeException wrapped.

The default implementation will:

• throw a NullPointerException if nodeHierarchicalVisitor is null.
• throw a NodeTraversalException if nodeHierarchicalVisitor throws a RuntimeException.
• traverse its child Nodes.

Specified by:

accept in interface Node

Parameters:

nodeHierarchicalVisitor - the NodeHierarchicalVisitor to accept

Returns:

the result of nodeHierarchicalVisitor.visitLeave(this)

Throws:

NodeTraversalException - thrown if, and only if, a RuntimeException is thrown by the current NodeHierarchicalVisitor

java.lang.NullPointerException - thrown if, and only if, nodeHierarchicalVisitor is null

getNodes

public final java.util.List<Node> getNodes()

Returns the Nodes currently added to this AbstractTree.

Modifying the returned List will not affect this AbstractTree.

Specified by:

getNodes in interface Tree

Returns:

the Nodes currently added to this AbstractTree