com.helger.commons.tree

Class BasicTree<DATATYPE,ITEMTYPE extends ITreeItem<DATATYPE,ITEMTYPE>>

java.lang.Object

com.helger.commons.tree.BasicTree<DATATYPE,ITEMTYPE>

Type Parameters:

DATATYPE - tree item value type

ITEMTYPE - tree item implementation type

All Implemented Interfaces:

IHasChildren<ITEMTYPE>, IBasicTree<DATATYPE,ITEMTYPE>, ITree<DATATYPE,ITEMTYPE>

Direct Known Subclasses:

DefaultTree

@NotThreadSafe
public class BasicTree<DATATYPE,ITEMTYPE extends ITreeItem<DATATYPE,ITEMTYPE>>
extends Object
implements ITree<DATATYPE,ITEMTYPE>

Root class for a simple tree. The elements of the tree are not sorted by any means.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
BasicTree(ITreeItemFactory<DATATYPE,ITEMTYPE> aFactory)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
Collection<? extends ITEMTYPE>	getAllChildren()
int	getChildCount()
ITEMTYPE	getRootItem()
boolean	hasChildren()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BasicTree

public BasicTree(@Nonnull
         ITreeItemFactory<DATATYPE,ITEMTYPE> aFactory)

Method Detail

hasChildren

public final boolean hasChildren()

Specified by:

hasChildren in interface IHasChildren<ITEMTYPE extends ITreeItem<DATATYPE,ITEMTYPE>>

Returns:

true if this item has direct children, false otherwise.

getChildCount

@Nonnegative
public int getChildCount()

Specified by:

getChildCount in interface IHasChildren<ITEMTYPE extends ITreeItem<DATATYPE,ITEMTYPE>>

Returns:

The number of contained direct children. Always ≥ 0.

getAllChildren

@Nonnull
@ReturnsMutableCopy
public final Collection<? extends ITEMTYPE> getAllChildren()

Specified by:

getAllChildren in interface IHasChildren<ITEMTYPE extends ITreeItem<DATATYPE,ITEMTYPE>>

Returns:

A collection of all direct child elements. May be null .

getRootItem

@Nonnull
public final ITEMTYPE getRootItem()

Specified by:

getRootItem in interface IBasicTree<DATATYPE,ITEMTYPE extends ITreeItem<DATATYPE,ITEMTYPE>>

Returns:

The root item of the tree. Never null. The root item should not be displayed but it is the parent node of all displayed root items and therefore cannot be removed.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object