com.helger.commons.tree.simple

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

java.lang.Object

com.helger.commons.tree.simple.BasicTreeItem<DATATYPE,ITEMTYPE>

Type Parameters:

DATATYPE - tree item value type

ITEMTYPE - tree item implementation type

All Implemented Interfaces:

IHasChildren<ITEMTYPE>, IHasChildrenSorted<ITEMTYPE>, IHasParent<ITEMTYPE>, IBasicTreeItem<DATATYPE,ITEMTYPE>, ITreeItem<DATATYPE,ITEMTYPE>

Direct Known Subclasses:

DefaultTreeItem

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

Basic implementation of the ITreeItem interface

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
BasicTreeItem(ITEMTYPE aParent) Constructor for normal elements.
BasicTreeItem(ITreeItemFactory<DATATYPE,ITEMTYPE> aFactory) Constructor for root object.

Method Summary

Methods

Modifier and Type	Method and Description
ESuccess	changeParent(ITEMTYPE aNewParent) Change the parent node of this node to another node (subordination).
ITEMTYPE	createChildItem(DATATYPE aData) Add a child item to this item.
boolean	equals(Object o)
List<DATATYPE>	getAllChildDatas() Get the data values of all contained children.
ITEMTYPE	getChildAtIndex(int nIndex) Get the child node at the specified index
int	getChildCount()
List<ITEMTYPE>	getChildren()
DATATYPE	getData()
ITreeItemFactory<DATATYPE,ITEMTYPE>	getFactory()
ITEMTYPE	getFirstChild() Get the first child node or null if no child is present
ITEMTYPE	getLastChild() Get the last child node or null if no child is present
ITEMTYPE	getParent() Get the parent object of this object.
DATATYPE	getParentData()
boolean	hasChildren()
int	hashCode()
EChange	internalAddChild(ITEMTYPE aChild) Add an existing child to this tree item.
boolean	isRootItem()
boolean	isSameOrChildOf(ITEMTYPE aParent) Check if this item is the same or a child of the passed item.
protected boolean	isValidData(DATATYPE aData) This method is called to validate a data object.
EChange	removeChild(ITEMTYPE aChild) Remove the passed node as a child node from this node.
void	reorderChildItems(Comparator<? super ITEMTYPE> aComparator) Reorder the child items based on the item itself.
void	setData(DATATYPE aData) Change the data associated with this node.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicTreeItem

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

Constructor for root object.

Parameters:

aFactory - The factory to use for creating tree items. May not be null.

BasicTreeItem

public BasicTreeItem(@Nonnull
             ITEMTYPE aParent)

Constructor for normal elements.

Parameters:

aParent - Parent item to use. May never be null since only the root has no parent and for the root item a special no-argument constructor is present.

Method Detail

getFactory

@Nonnull
public final ITreeItemFactory<DATATYPE,ITEMTYPE> getFactory()

Specified by:

getFactory in interface ITreeItem<DATATYPE,ITEMTYPE extends ITreeItem<DATATYPE,ITEMTYPE>>

Returns:

The factory used to create instances of this interface.

isValidData

@OverrideOnDemand
protected boolean isValidData(DATATYPE aData)

This method is called to validate a data object. This method may be overloaded in derived classes. The default implementation accepts all values.

Parameters:

aData - The value to validate.

Returns:

true if the ID is valid, false otherwise.

getData

@Nullable
public final DATATYPE getData()

Specified by:

getData in interface IBasicTreeItem<DATATYPE,ITEMTYPE extends ITreeItem<DATATYPE,ITEMTYPE>>

Returns:

the data associated with this node. May be null.

setData

public final void setData(@Nullable
           DATATYPE aData)

Description copied from interface: IBasicTreeItem

Change the data associated with this node.

Specified by:

setData in interface IBasicTreeItem<DATATYPE,ITEMTYPE extends ITreeItem<DATATYPE,ITEMTYPE>>

Parameters:

aData - The data associated with this node. May be null.

isRootItem

public final boolean isRootItem()

Specified by:

isRootItem in interface IBasicTreeItem<DATATYPE,ITEMTYPE extends ITreeItem<DATATYPE,ITEMTYPE>>

Returns:

true if this is the internal root item without a parent, false if this is a public item.

getParent

@Nullable
public final ITEMTYPE getParent()

Description copied from interface: IHasParent

Get the parent object of this object.

Specified by:

getParent in interface IHasParent<ITEMTYPE extends ITreeItem<DATATYPE,ITEMTYPE>>

Returns:

The parent object or null if this object has no parent.

getParentData

@Nullable
public final DATATYPE getParentData()

Specified by:

getParentData in interface IBasicTreeItem<DATATYPE,ITEMTYPE extends ITreeItem<DATATYPE,ITEMTYPE>>

Returns:

the data associated with the parent node. May be null.

createChildItem

@Nonnull
public final ITEMTYPE createChildItem(@Nullable
                               DATATYPE aData)

Add a child item to this item.

Specified by:

createChildItem in interface ITreeItem<DATATYPE,ITEMTYPE extends ITreeItem<DATATYPE,ITEMTYPE>>

Parameters:

aData - the data associated with this item

Returns:

the created TreeItem object or null if the ID is already in use and bAllowOverwrite is false

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.

getChildren

@Nullable
@ReturnsMutableCopy
public final List<ITEMTYPE> getChildren()

Specified by:

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

Specified by:

getChildren in interface IHasChildrenSorted<ITEMTYPE extends ITreeItem<DATATYPE,ITEMTYPE>>

Returns:

A ordered list of child elements. May be null if no children are present.

getAllChildDatas

@Nullable
public final List<DATATYPE> getAllChildDatas()

Description copied from interface: IBasicTreeItem

Get the data values of all contained children.

Specified by:

getAllChildDatas in interface IBasicTreeItem<DATATYPE,ITEMTYPE extends ITreeItem<DATATYPE,ITEMTYPE>>

Returns:

null if this item does not have children. Use IHasChildren.hasChildren() to check for the existence.

getChildAtIndex

@Nullable
public final ITEMTYPE getChildAtIndex(@Nonnegative
                                int nIndex)

Description copied from interface: IHasChildrenSorted

Get the child node at the specified index

Specified by:

getChildAtIndex in interface IHasChildrenSorted<ITEMTYPE extends ITreeItem<DATATYPE,ITEMTYPE>>

Parameters:

nIndex - The index to be queried. May not be < 0 or ≥ the number of children

Returns:

The child at the specified index or null if the index is invalid.

getChildCount

@Nonnegative
public final int getChildCount()

Specified by:

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

Returns:

The number of contained direct children. Always ≥ 0.

getFirstChild

@Nullable
public ITEMTYPE getFirstChild()

Description copied from interface: IHasChildrenSorted

Get the first child node or null if no child is present

Specified by:

getFirstChild in interface IHasChildrenSorted<ITEMTYPE extends ITreeItem<DATATYPE,ITEMTYPE>>

Returns:

The first child or null.

getLastChild

@Nullable
public ITEMTYPE getLastChild()

Description copied from interface: IHasChildrenSorted

Get the last child node or null if no child is present

Specified by:

getLastChild in interface IHasChildrenSorted<ITEMTYPE extends ITreeItem<DATATYPE,ITEMTYPE>>

Returns:

The last child or null.

isSameOrChildOf

public final boolean isSameOrChildOf(@Nonnull
                      ITEMTYPE aParent)

Description copied from interface: IBasicTreeItem

Check if this item is the same or a child of the passed item. This is not limited to direct children but to children on all levels.

Specified by:

isSameOrChildOf in interface IBasicTreeItem<DATATYPE,ITEMTYPE extends ITreeItem<DATATYPE,ITEMTYPE>>

Parameters:

aParent - The parent item to check whether this is a child of it. May not be null.

Returns:

true if this is the same or a child of aParent.

changeParent

@Nonnull
public final ESuccess changeParent(@Nonnull
                            ITEMTYPE aNewParent)

Description copied from interface: IBasicTreeItem

Change the parent node of this node to another node (subordination).

Specified by:

changeParent in interface IBasicTreeItem<DATATYPE,ITEMTYPE extends ITreeItem<DATATYPE,ITEMTYPE>>

Parameters:

aNewParent - The new parent to use. May not be null. To make it a root item, pass the owning tree's root item.

Returns:

ESuccess

internalAddChild

@Nonnull
public final EChange internalAddChild(@Nonnull
                               ITEMTYPE aChild)

Description copied from interface: ITreeItem

Add an existing child to this tree item. Use only internally!

Specified by:

internalAddChild in interface ITreeItem<DATATYPE,ITEMTYPE extends ITreeItem<DATATYPE,ITEMTYPE>>

Parameters:

aChild - The child to be added. May not be null.

Returns:

EChange.UNCHANGED if the child is already contained, EChange.CHANGED upon success.

removeChild

@Nonnull
public final EChange removeChild(@Nonnull
                          ITEMTYPE aChild)

Description copied from interface: ITreeItem

Remove the passed node as a child node from this node.

Specified by:

removeChild in interface ITreeItem<DATATYPE,ITEMTYPE extends ITreeItem<DATATYPE,ITEMTYPE>>

Parameters:

aChild - The child to be removed. May not be null.

Returns:

EChange.CHANGED if the removal succeeded, EChange.UNCHANGED otherwise

reorderChildItems

public final void reorderChildItems(@Nonnull
                     Comparator<? super ITEMTYPE> aComparator)

Description copied from interface: ITreeItem

Reorder the child items based on the item itself.

Specified by:

reorderChildItems in interface ITreeItem<DATATYPE,ITEMTYPE extends ITreeItem<DATATYPE,ITEMTYPE>>

Parameters:

aComparator - The comparator use. May not be null.

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