Tree

java.lang.Object
- tree.Tree<T>

Type Parameters:
T - The type of value held in each node of this Tree.
```
public class Tree<T>
extends java.lang.Object
```
General tree API.

Version:

March 7, 2012

Author:

David Matuszek

Constructor Summary

Constructors
Constructor and Description

Tree(T value)
Constructor for Tree objects.

Constructors
Constructor and Description
`Tree(T value)` Constructor for Tree objects.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addChild(Tree<T> newChild)` Adds a child to this node, following any previously existing children.
`void`	`addChildren(Tree<T>... newChildren)` Adds any number of children to this node, following any previously existing children.
`java.util.ArrayList<Tree<T>>`	`children()` Returns a list of the children of this node.
`int`	`depth()` Returns the distance from the root of this node.
`boolean`	`equals(java.lang.Object o)`
`Tree<T>`	`firstChild()` Returns the leftmost child of this node, or `null` if this node has no children.
`T`	`getValue()` Returns the value in this node of the tree.
`boolean`	`hasAncestor(Tree<T> ancestor)` Tests whether its parameter is an ancestor node of this node.
`boolean`	`hasChildren()` Tests whether this node is a leaf.
`int`	`hashCode()`
`boolean`	`hasNextSibling()` Tests whether this node has a sibling on its right.
`boolean`	`hasPreviousSibling()` Tests whether this node has a sibling on its left.
`boolean`	`isLeaf()` Tests whether this node is a leaf.
`boolean`	`isRoot()` Tests whether this tree node is the root.
`java.util.Iterator<Tree<T>>`	`iterator()` Returns a preorder iterator for this Tree.
`Tree<T>`	`lastChild()` Returns the rightmost child of this node, or `null` if this node has no children.
`Tree<T>`	`nextSibling()` Returns the next child of the parent of this node, or `null` if there are no additional children.
`Tree<T>`	`parent()` Returns the parent of this node, or `null` if this node is the root.
`Tree<T>`	`previousSibling()` Returns the previous child of the parent of this node, or `null` if there are no prior children.
`void`	`print()` Prints this Tree, in indented fashion.
`void`	`remove()` Detaches this node from its parent.
`void`	`setValue(T value)` Sets the value in this node of the tree.
`java.lang.String`	`toString()` Returns a single-line string representation of this Tree.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Tree
```
public Tree(T value)
```
    Constructor for Tree objects. Creates a single node containing the specified value.
    
    Parameters:
    value - The value to put in the new tree node.
- Method Detail
  - getValue
```
public T getValue()
```
    Returns the value in this node of the tree.
    
    Returns:
    The value in this node of the tree.
  - setValue
```
public void setValue(T value)
```
    Sets the value in this node of the tree.
    
    Parameters:
    value - The value to put in this node.
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
    
    See Also:
    Object.equals(java.lang.Object)
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
    
    See Also:
    Object.hashCode()
  - isRoot
```
public boolean isRoot()
```
    Tests whether this tree node is the root.
    
    Returns:
    true if this node has no parent.
  - isLeaf
```
public boolean isLeaf()
```
    Tests whether this node is a leaf.
    
    Returns:
    true if this node has no children.
  - hasChildren
```
public boolean hasChildren()
```
    Tests whether this node is a leaf.
    
    Returns:
    true if this node has children.
  - hasNextSibling
```
public boolean hasNextSibling()
```
    Tests whether this node has a sibling on its right.
    
    Returns:
    true if this node has a right sibling.
  - hasPreviousSibling
```
public boolean hasPreviousSibling()
```
    Tests whether this node has a sibling on its left.
    
    Returns:
    true if this node has a left sibling.
  - parent
```
public Tree<T> parent()
```
    Returns the parent of this node, or null if this node is the root.
    
    Returns:
    the parent of this node.
  - firstChild
```
public Tree<T> firstChild()
```
    Returns the leftmost child of this node, or null if this node has no children.
    
    Returns:
    The leftmost child of this node.
  - lastChild
```
public Tree<T> lastChild()
```
    Returns the rightmost child of this node, or null if this node has no children.
    
    Returns:
    The rightmost child of this node.
  - children
```
public java.util.ArrayList<Tree<T>> children()
```
    Returns a list of the children of this node.
    
    Returns:
    the children of this node.
  - nextSibling
```
public Tree<T> nextSibling()
```
    Returns the next child of the parent of this node, or null if there are no additional children.
    
    Returns:
    the next sibling, if any.
  - previousSibling
```
public Tree<T> previousSibling()
```
    Returns the previous child of the parent of this node, or null if there are no prior children.
    
    Returns:
    the previous sibling, if any.
  - depth
```
public int depth()
```
    Returns the distance from the root of this node.
    
    Returns:
    the distance from the root.
  - hasAncestor
```
public boolean hasAncestor(Tree<T> ancestor)
```
    Tests whether its parameter is an ancestor node of this node. A node is considered to be an ancestor of itself.
    
    Parameters:
    ancestor - A possible ancestor of this node.
    
    Returns:
    true if the parameter is an ancestor of this node.
  - addChild
```
public void addChild(Tree<T> newChild)
```
    Adds a child to this node, following any previously existing children.
    
    Parameters:
    newChild - The node to be added as a child.
  - addChildren
```
@SafeVarargs
public final void addChildren(Tree<T>... newChildren)
```
    Adds any number of children to this node, following any previously existing children.
    
    Parameters:
    newChildren - The nodes to be added as children.
  - remove
```
public void remove()
```
    Detaches this node from its parent.
  - iterator
```
public java.util.Iterator<Tree<T>> iterator()
```
    Returns a preorder iterator for this Tree. Each returned value is a node of the tree, beginning with the root.
    
    Returns:
    A preorder iterator.
  - toString
```
public java.lang.String toString()
```
    Returns a single-line string representation of this Tree.
    
    Overrides:
    
    toString in class java.lang.Object
    
    See Also:
    Object.toString()
  - print
```
public void print()
```
    Prints this Tree, in indented fashion.

Class Tree<T>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Tree

Method Detail

getValue

setValue

equals

hashCode

isRoot

isLeaf

hasChildren

hasNextSibling

hasPreviousSibling

parent

firstChild

lastChild

children

nextSibling

previousSibling

depth

hasAncestor

addChild

addChildren

remove

iterator

toString

print