net.sf.mmm.util.collection.base

Class AbstractGenericTreeNode<CHILD extends Node<PARENT>,PARENT extends GenericTreeNode<CHILD,PARENT>>

java.lang.Object

net.sf.mmm.util.collection.base.AbstractGenericTreeNode<CHILD,PARENT>

Type Parameters:

CHILD - is the generic type of the children.

PARENT - is the generic type of the parent.

All Implemented Interfaces:

GenericTreeNode<CHILD,PARENT>, Node<PARENT>

Direct Known Subclasses:

AbstractTreeNode

public abstract class AbstractGenericTreeNode<CHILD extends Node<PARENT>,PARENT extends GenericTreeNode<CHILD,PARENT>>
extends Object
implements GenericTreeNode<CHILD,PARENT>

This is the abstract base implementation of the GenericTreeNode interface.

Since:

3.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private List<CHILD>	children
private List<CHILD>	mutableChildList
private PARENT	parent

Constructor Summary

Constructors

Constructor and Description
AbstractGenericTreeNode() The constructor.
AbstractGenericTreeNode(ListFactory listFactory) The constructor.
AbstractGenericTreeNode(PARENT parent) The constructor.
AbstractGenericTreeNode(PARENT parent, ListFactory listFactory) The constructor.

Method Summary

Modifier and Type	Method and Description
protected void	addChild(CHILD child) This method adds the given child to the children of this GenericTreeNode.
protected void	addChild(CHILD child, int index) This method adds the given child to the children of this GenericTreeNode.
List<CHILD>	getChildren() This method gets the List containing all children of this GenericTreeNode.
protected List<CHILD>	getMutableChildList()
PARENT	getParent() This method gets the parent of this GenericTreeNode.
boolean	isAncestor(PARENT node) This method determines if this GenericTreeNode is an ancestor of the given node.
boolean	isDescendant(CHILD node) This method determines if this GenericTreeNode is a descendant of the given node.
protected boolean	removeChild(CHILD child) This method removes the given child from the children of this GenericTreeNode.
protected CHILD	removeChild(int index) This method removes the child from the children of this GenericTreeNode at the given index.
protected void	setParent(PARENT parent) This method sets the parent of this GenericTreeNode.

Methods inherited from class java.lang.Object

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

Field Detail

mutableChildList

private final transient List<CHILD extends Node<PARENT>> mutableChildList

children

private final List<CHILD extends Node<PARENT>> children

parent

private PARENT extends GenericTreeNode<CHILD,PARENT> parent

Constructor Detail

AbstractGenericTreeNode

public AbstractGenericTreeNode()

The constructor.

AbstractGenericTreeNode

public AbstractGenericTreeNode(PARENT parent)

The constructor.

Parameters:

parent - is the parent node.

AbstractGenericTreeNode

public AbstractGenericTreeNode(ListFactory listFactory)

The constructor.

Parameters:

listFactory - the factory used to create the internal List.

AbstractGenericTreeNode

public AbstractGenericTreeNode(PARENT parent,
                               ListFactory listFactory)

The constructor.

Parameters:

parent - is the parent node.

listFactory - the factory used to create the internal List.

Method Detail

getParent

public PARENT getParent()

Description copied from interface: GenericTreeNode

This method gets the parent of this GenericTreeNode.

Specified by:

getParent in interface GenericTreeNode<CHILD extends Node<PARENT>,PARENT extends GenericTreeNode<CHILD,PARENT>>

Specified by:

getParent in interface Node<PARENT extends GenericTreeNode<CHILD,PARENT>>

Returns:

the parent GenericTreeNode or null if this is the root- GenericTreeNode.

setParent

protected void setParent(PARENT parent)

This method sets the parent of this GenericTreeNode.

Parameters:

parent - is the parent to set. It may be null. However you should typically only call this method once with a non-null argument. It is still legal to re-arrange the tree-structure on existing GenericTreeNodes.

getChildren

public List<CHILD> getChildren()

Description copied from interface: GenericTreeNode

This method gets the List containing all children of this GenericTreeNode. The List may be empty - in such case we call this GenericTreeNode a leaf . Each item of the returned List is called a child or child-node. It should return this GenericTreeNode as parent.

Specified by:

getChildren in interface GenericTreeNode<CHILD extends Node<PARENT>,PARENT extends GenericTreeNode<CHILD,PARENT>>

Returns:

the List containing all children of this GenericTreeNode.

getMutableChildList

protected List<CHILD> getMutableChildList()

Returns:

the mutableChildList

addChild

protected void addChild(CHILD child)

This method adds the given child to the children of this GenericTreeNode.

Parameters:

child - is the child to add. It's parent has to be identical to this GenericTreeNode.

addChild

protected void addChild(CHILD child,
                        int index)

This method adds the given child to the children of this GenericTreeNode.

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.

removeChild

protected boolean removeChild(CHILD child)

This method removes the given child from the children of this GenericTreeNode.

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.

removeChild

protected CHILD removeChild(int index)

This method removes the child from the children of this GenericTreeNode at the given index.

Parameters:

index - is index of the child to remove.

Returns:

the child that has actually been removed.

isAncestor

public boolean isAncestor(PARENT node)

Description copied from interface: GenericTreeNode

This method determines if this GenericTreeNode is an ancestor of the given node. In other words this method checks if this GenericTreeNode is the direct or indirect parent of the given node.

Specified by:

isAncestor in interface GenericTreeNode<CHILD extends Node<PARENT>,PARENT extends GenericTreeNode<CHILD,PARENT>>

Parameters:

node - is the GenericTreeNode to check (the potential descendant ).

Returns:

true if this GenericTreeNode is an ancestor of the given node.

isDescendant

public boolean isDescendant(CHILD node)

Description copied from interface: GenericTreeNode

This method determines if this GenericTreeNode is a descendant of the given node. In other words this method checks if this GenericTreeNode is the direct or indirect child of the given node.

Specified by:

isDescendant in interface GenericTreeNode<CHILD extends Node<PARENT>,PARENT extends GenericTreeNode<CHILD,PARENT>>

Parameters:

node - is the GenericTreeNode to check (the potential ancestor).

Returns:

true if this GenericTreeNode is an descendant of the given node .