TreeNodeSimple (JavaDocs for mmm-all dev-SNAPSHOT)

java.lang.Object
- net.sf.mmm.util.collection.base.AbstractGenericTreeNode<NODE,NODE>
- - net.sf.mmm.util.collection.base.AbstractTreeNode<TreeNodeSimple<VALUE>>
  - - net.sf.mmm.util.collection.base.TreeNodeSimple<VALUE>

Type Parameters:

VALUE - is the generic type of the value contained in each node.

All Implemented Interfaces:

GenericTreeNode<TreeNodeSimple<VALUE>,TreeNodeSimple<VALUE>>, Node<TreeNodeSimple<VALUE>>, TreeNode<TreeNodeSimple<VALUE>>, AttributeReadValue<VALUE>, AttributeWriteValue<VALUE>
```
public class TreeNodeSimple<VALUE>
extends AbstractTreeNode<TreeNodeSimple<VALUE>>
implements AttributeWriteValue<VALUE>
```
This is a simple but generic implementation of TreeNode. It can carry any kind of value that can be set externally.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields
Modifier and Type Field and Description

private VALUE value

Fields
Modifier and Type	Field and Description
`private VALUE`	`value`

Constructor Summary

Constructors
Constructor and Description
`TreeNodeSimple()` The constructor.
`TreeNodeSimple(TreeNodeSimple<VALUE> parent)` The constructor.
`TreeNodeSimple(TreeNodeSimple<VALUE> parent, ListFactory listFactory)` The constructor.
`TreeNodeSimple(TreeNodeSimple<VALUE> parent, VALUE value)` The constructor.
`TreeNodeSimple(VALUE value)` The constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addChild(TreeNodeSimple<VALUE> child)` This method adds the given `child` to the `children` of this `GenericTreeNode`.
`void`	`addChild(TreeNodeSimple<VALUE> child, int index)` This method adds the given `child` to the `children` of this `GenericTreeNode`.
`void`	`addChildValue(VALUE childValue)` Creates a new `TreeNodeSimple` with the given `childValue` and `adds it as child` of this node.
`void`	`addChildValue(VALUE childValue, int index)` Creates a new `TreeNodeSimple` with the given `childValue` and `inserts it as child` of this node at the given `index`.
`VALUE`	`getValue()` This method gets the value of this object.
`TreeNodeSimple<VALUE>`	`removeChild(int index)` This method removes the `child` from the `children` of this `GenericTreeNode` at the given `index`.
`boolean`	`removeChild(TreeNodeSimple<VALUE> child)` This method removes the given `child` from the `children` of this `GenericTreeNode`.
`void`	`setValue(VALUE value)` This method sets the `value`.
`String`	`toString()`

Methods inherited from class net.sf.mmm.util.collection.base.AbstractGenericTreeNode
getChildren, getMutableChildList, getParent, isAncestor, isDescendant, setParent

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

Methods inherited from interface net.sf.mmm.util.collection.api.GenericTreeNode
getChildren, getParent, isAncestor, isDescendant

- Field Detail
  - value
```
private VALUE value
```
- Constructor Detail
  - TreeNodeSimple
```
public TreeNodeSimple()
```
    The constructor.
  - TreeNodeSimple
```
public TreeNodeSimple(VALUE value)
```
    The constructor.
    
    Parameters:
    
    value - is the value.
  - TreeNodeSimple
```
public TreeNodeSimple(TreeNodeSimple<VALUE> parent,
                      ListFactory listFactory)
```
    The constructor.
    
    Parameters:
    
    parent - is the parent node.
    
    listFactory - the factory used to create the internal List.
  - TreeNodeSimple
```
public TreeNodeSimple(TreeNodeSimple<VALUE> parent)
```
    The constructor.
    
    Parameters:
    
    parent - is the parent node.
  - TreeNodeSimple
```
public TreeNodeSimple(TreeNodeSimple<VALUE> parent,
                      VALUE value)
```
    The constructor.
    
    Parameters:
    
    parent - is the parent node.
    
    value - is the value.
- Method Detail
  - getValue
```
public VALUE getValue()
```
    Description copied from interface: AttributeReadValue
    
    This method gets the value of this object.
    
    Specified by:
    
    getValue in interface AttributeReadValue<VALUE>
    
    Returns:
    
    the value of this object. May be null unless otherwise stated.
  - setValue
```
public void setValue(VALUE value)
```
    Description copied from interface: AttributeWriteValue
    
    This method sets the value.
    
    Specified by:
    
    setValue in interface AttributeWriteValue<VALUE>
    
    Parameters:
    
    value - is the new value. May be null unless otherwise stated.
  - addChild
```
public void addChild(TreeNodeSimple<VALUE> child)
```
    Description copied from class: AbstractGenericTreeNode
    
    This method adds the given child to the children of this GenericTreeNode.
    
    Overrides:
    
    addChild in class AbstractGenericTreeNode<TreeNodeSimple<VALUE>,TreeNodeSimple<VALUE>>
    
    Parameters:
    
    child - is the child to add. It's parent has to be identical to this GenericTreeNode.
  - addChild
```
public void addChild(TreeNodeSimple<VALUE> child,
                     int index)
```
    Description copied from class: AbstractGenericTreeNode
    
    This method adds the given child to the children of this GenericTreeNode.
    
    Overrides:
    
    addChild in class AbstractGenericTreeNode<TreeNodeSimple<VALUE>,TreeNodeSimple<VALUE>>
    
    Parameters:
    
    child - is the child to add. It's parent has to be identical to this GenericTreeNode.
    
    index - is the index where to insert the new child.
  - addChildValue
```
public void addChildValue(VALUE childValue)
```
    Creates a new TreeNodeSimple with the given childValue and adds it as child of this node.
    
    Parameters:
    
    childValue - is the value of the new child node.
  - addChildValue
```
public void addChildValue(VALUE childValue,
                          int index)
```
    Creates a new TreeNodeSimple with the given childValue and inserts it as child of this node at the given index.
    
    Parameters:
    
    childValue - is the value of the new child node.
    
    index - is the index where to insert the new child.
  - removeChild
```
public TreeNodeSimple<VALUE> removeChild(int index)
```
    Description copied from class: AbstractGenericTreeNode
    
    This method removes the child from the children of this GenericTreeNode at the given index.
    
    Overrides:
    
    removeChild in class AbstractGenericTreeNode<TreeNodeSimple<VALUE>,TreeNodeSimple<VALUE>>
    
    Parameters:
    
    index - is index of the child to remove.
    
    Returns:
    
    the child that has actually been removed.
  - removeChild
```
public boolean removeChild(TreeNodeSimple<VALUE> child)
```
    Description copied from class: AbstractGenericTreeNode
    
    This method removes the given child from the children of this GenericTreeNode.
    
    Overrides:
    
    removeChild in class AbstractGenericTreeNode<TreeNodeSimple<VALUE>,TreeNodeSimple<VALUE>>
    
    Parameters:
    
    child - is the child to remove.
    
    Returns:
    
    true if the given child was contained in this GenericTreeNodes children and has been removed successfully, false otherwise.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class TreeNodeSimple<VALUE>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class net.sf.mmm.util.collection.base.AbstractGenericTreeNode

Methods inherited from class java.lang.Object

Methods inherited from interface net.sf.mmm.util.collection.api.GenericTreeNode

Field Detail

value

Constructor Detail

TreeNodeSimple

TreeNodeSimple

TreeNodeSimple

TreeNodeSimple

TreeNodeSimple

Method Detail

getValue

setValue

addChild

addChild

addChildValue

addChildValue

removeChild

removeChild

toString