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

Interface Tree.Builder<T extends Node>

All Known Implementing Classes:

AbstractTree.AbstractBuilder, SimpleTree.SimpleBuilder

Enclosing interface:

Tree

public static interface Tree.Builder<T extends Node>

A Builder allows you to build immutable Trees.

It uses the design pattern Builder.

Since:

1.0.0

Author:

Jörgen Lundgren

Method Summary

Modifier and Type	Method and Description
Tree.Builder<T>	addNode(Node node) Adds node to this Builder instance.
T	build() Returns a new (possibly immutable) Tree instance.
Tree.Builder<T>	removeNode(Node node) Removes node from this Builder instance.

Method Detail

addNode

Tree.Builder<T> addNode(Node node)

Adds node to this Builder instance.

Returns the Builder instance itself.

If node is null, a NullPointerException may be thrown. But no guarantees can be made.

Parameters:

node - the Node to add

Returns:

the Builder instance itself

Throws:

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

removeNode

Tree.Builder<T> removeNode(Node node)

Removes node from this Builder instance.

Returns the Builder instance itself.

If node is null, a NullPointerException may be thrown. But no guarantees can be made.

Parameters:

node - the Node to remove

Returns:

the Builder instance itself

Throws:

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

build

T build()

Returns a new (possibly immutable) Tree instance.

Returns:

a new (possibly immutable) Tree instance