Node (Artisynth API documentation)

java.lang.Object
- maspack.graph.Node<T>

Direct Known Subclasses:

BiNode
```
public class Node<T>
extends java.lang.Object
```
Represents a node of the Tree<T> class. The Node<T> is also a container, and can be thought of as instrumentation to determine the location of the type T in the Tree<T>. Ideas from: http://sujitpal.blogspot.ca/2006/05/java-data-structure-generic-tree.html

Constructor Summary

Constructors
Constructor and Description

Node()
Default constructor.

Node(T data)
Convenience ctor to create a Node<T> with an instance of T.

Constructors
Constructor and Description
`Node()` Default constructor.
`Node(T data)` Convenience ctor to create a `Node<T>` with an instance of T.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addChild(Node<T> child)` Adds a child to the list of children for this `Node<T>`.
`void`	`addChildren(java.util.List<Node<T>> newChildren)` Adds a list of children to this `Node<T>`.
`void`	`clear()` Removes the branch below this item, clearing children if this is the only parent
`void`	`consolidate()` merges children with equal content, reducing branches
`void`	`detachFromParent(Node<T> parent)` Removes child from a particular parent
`void`	`detachFromParents()` Removes node from all parents
`boolean`	`equalsNode(Node<T> node)` Value-equality of nodes and all children (i.e.
`Node<T>`	`getChild(int idx)` Gets a child at a particular index
`java.util.List<Node<T>>`	`getChildren()` Return the children of `Node<T>`.
`T`	`getData()`
`int`	`getNumberOfChildren()` Returns the number of immediate children of this `Node<T>`.
`int`	`getNumberOfParents()` Returns the number of immediate parents of this `Node<T>`.
`Node<T>`	`getParent(int idx)`
`java.util.List<Node<T>>`	`getParents()`
`void`	`insertChildAt(int index, Node<T> child)` Adds a child to the list of children for this `Node<T>` at a particular index
`void`	`removeAllChildren()` Clears all children, ensuring to remove the parent entry
`void`	`removeChild(int index)` Remove the `Node<T>` element at index index of the `List<Node<T>>`.
`void`	`removeChild(Node<T> child)` Remove the `Node<T>` element
`void`	`setChildren(java.util.List<Node<T>> children)` Sets the children of a `Node<T>` object.
`void`	`setData(T data)`
`java.lang.String`	`toString()`

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

- Constructor Detail
  - Node
```
public Node()
```
    Default constructor.
  - Node
```
public Node(T data)
```
    Convenience ctor to create a Node<T> with an instance of T.
    
    Parameters:
    
    data - an instance of T.
- Method Detail
  - getChildren
```
public java.util.List<Node<T>> getChildren()
```
    Return the children of Node<T>. The Tree<T> is represented by a single root Node<T> whose children are represented by a List<Node<T>>. Each of these Node<T> elements in the List can have children. The getChildren() method will return the children of a Node<T>.
    
    Returns:
    
    the children of Node<T>
  - getChild
```
public Node<T> getChild(int idx)
                 throws java.lang.IndexOutOfBoundsException
```
    Gets a child at a particular index
    
    Parameters:
    
    idx - the index of the child to get
    
    Returns:
    
    the child
    
    Throws:
    
    java.lang.IndexOutOfBoundsException
  - setChildren
```
public void setChildren(java.util.List<Node<T>> children)
```
    Sets the children of a Node<T> object. See docs for getChildren() for more information.
    
    Parameters:
    
    children - the List<Node<T>> to set.
  - getNumberOfChildren
```
public int getNumberOfChildren()
```
    Returns the number of immediate children of this Node<T>.
    
    Returns:
    
    the number of immediate children.
  - getNumberOfParents
```
public int getNumberOfParents()
```
    Returns the number of immediate parents of this Node<T>.
    
    Returns:
    
    the number of immediate parents.
  - addChild
```
public void addChild(Node<T> child)
```
    Adds a child to the list of children for this Node<T>. The addition of the first child will create a new List<Node<T>>.
    
    Parameters:
    
    child - a Node<T> object to set.
  - insertChildAt
```
public void insertChildAt(int index,
                          Node<T> child)
```
    Adds a child to the list of children for this Node<T> at a particular index
    
    Parameters:
    
    index - the index at which to insert the child
    
    child - a Node<T> object to set.
  - getParents
```
public java.util.List<Node<T>> getParents()
```
  - getParent
```
public Node<T> getParent(int idx)
```
  - addChildren
```
public void addChildren(java.util.List<Node<T>> newChildren)
```
    Adds a list of children to this Node<T>.
    
    Parameters:
    
    newChildren - list of Node<T> objects to add
  - removeChild
```
public void removeChild(int index)
                 throws java.lang.IndexOutOfBoundsException
```
    Remove the Node<T> element at index index of the List<Node<T>>.
    
    Parameters:
    
    index - the index of the element to delete.
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if thrown.
  - removeChild
```
public void removeChild(Node<T> child)
```
    Remove the Node<T> element
    
    Parameters:
    
    child - the node to remove
  - removeAllChildren
```
public void removeAllChildren()
```
    Clears all children, ensuring to remove the parent entry
  - detachFromParents
```
public void detachFromParents()
```
    Removes node from all parents
  - detachFromParent
```
public void detachFromParent(Node<T> parent)
```
    Removes child from a particular parent
    
    Parameters:
    
    parent - parent from which this node is to be removed
  - getData
```
public T getData()
```
  - setData
```
public void setData(T data)
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - clear
```
public void clear()
```
    Removes the branch below this item, clearing children if this is the only parent
  - equalsNode
```
public boolean equalsNode(Node<T> node)
```
    Value-equality of nodes and all children (i.e. entire tree)
    
    Parameters:
    
    node - node to compare with
    
    Returns:
    
    true if equals, false otherwise
  - consolidate
```
public void consolidate()
```
    merges children with equal content, reducing branches

Class Node<T>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Node

Node

Method Detail

getChildren

getChild

setChildren

getNumberOfChildren

getNumberOfParents

addChild

insertChildAt

getParents

getParent

addChildren

removeChild

removeChild

removeAllChildren

detachFromParents

detachFromParent

getData

setData

toString

clear

equalsNode

consolidate