net.sf.mmm.util.collection.api

Interface GenericTreeNode<CHILD extends Node<PARENT>,PARENT extends GenericTreeNode<CHILD,PARENT>>

Type Parameters:

CHILD - is the generic type of the children.

PARENT - is the generic type of the parent.

All Superinterfaces:

Node<PARENT>

All Known Subinterfaces:

ContentType, TreeNode<NODE>

All Known Implementing Classes:

AbstractGenericTreeNode, AbstractTreeNode, ContentTypeBean, TreeNodeSimple

public interface GenericTreeNode<CHILD extends Node<PARENT>,PARENT extends GenericTreeNode<CHILD,PARENT>>
extends Node<PARENT>

This is the interface for the node of a tree. The tree itself is defined by the root-node which is its only node in the tree that has no parent.
A GenericTreeNode is generic and allows different types for <CHILD> and <PARENT> (e.g. to implement a folder that can only have a folder as parent but can have any resource as child that is of type folder or file). For a regular simple tree node you can use TreeNode.

Since:

3.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Method Summary

Modifier and Type	Method and Description
List<? extends CHILD>	getChildren() This method gets the List containing all children of this GenericTreeNode.
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.

Method Detail

getParent

PARENT getParent()

This method gets the parent of this GenericTreeNode.

Specified by:

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

Returns:

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

getChildren

List<? extends CHILD> getChildren()

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.

Returns:

the List containing all children of this GenericTreeNode.

isDescendant

boolean isDescendant(CHILD node)

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.

Parameters:

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

Returns:

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

isAncestor

boolean isAncestor(PARENT node)

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.

Parameters:

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

Returns:

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