com.phloc.commons.tree.withid.folder

Class BasicFolderTreeItem<KEYTYPE,DATATYPE,COLLTYPE extends Collection<DATATYPE>,ITEMTYPE extends BasicFolderTreeItem<KEYTYPE,DATATYPE,COLLTYPE,ITEMTYPE>>

java.lang.Object

com.phloc.commons.tree.withid.BasicTreeItemWithID<KEYTYPE,COLLTYPE,ITEMTYPE>

com.phloc.commons.tree.withid.folder.BasicFolderTreeItem<KEYTYPE,DATATYPE,COLLTYPE,ITEMTYPE>

Type Parameters:

KEYTYPE - Key type

DATATYPE - Value type

COLLTYPE - Collection type consisting of value elements

ITEMTYPE - the implementation item type

All Implemented Interfaces:

IHasID<KEYTYPE>, IHasChildren<ITEMTYPE>, IHasChildrenSorted<ITEMTYPE>, IHasParent<ITEMTYPE>, IBasicTreeItem<COLLTYPE,ITEMTYPE>, IFolderTreeItem<KEYTYPE,DATATYPE,COLLTYPE,ITEMTYPE>, ITreeItemWithID<KEYTYPE,COLLTYPE,ITEMTYPE>

Direct Known Subclasses:

DefaultFolderTreeItem

@NotThreadSafe
public class BasicFolderTreeItem<KEYTYPE,DATATYPE,COLLTYPE extends Collection<DATATYPE>,ITEMTYPE extends BasicFolderTreeItem<KEYTYPE,DATATYPE,COLLTYPE,ITEMTYPE>>
extends BasicTreeItemWithID<KEYTYPE,COLLTYPE,ITEMTYPE>
implements IFolderTreeItem<KEYTYPE,DATATYPE,COLLTYPE,ITEMTYPE>

Base implementation of the IFolderTreeItem interface.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
BasicFolderTreeItem(IFolderTreeItemFactory<KEYTYPE,DATATYPE,COLLTYPE,ITEMTYPE> aFactory) Constructor for root object
BasicFolderTreeItem(IFolderTreeItemFactory<KEYTYPE,DATATYPE,COLLTYPE,ITEMTYPE> aFactory, KEYTYPE aDataID) Constructor for root object
BasicFolderTreeItem(ITEMTYPE aParent, KEYTYPE aDataID) Constructor for normal elements

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
KEYTYPE	getGlobalUniqueDataID()
int	hashCode()
String	toString()

Methods inherited from class com.phloc.commons.tree.withid.BasicTreeItemWithID

changeParent, containsChildItemWithDataID, createChildItem, createChildItem, getAllChildDataIDs, getAllChildDatas, getChildAtIndex, getChildCount, getChildItemOfDataID, getChildren, getData, getFactory, getFirstChild, getID, getLastChild, getParent, getParentData, getParentID, hasChildren, internalAddChild, isRootItem, isSameOrChildOf, isValidData, isValidDataID, removeAllChildren, removeChild, reorderChildrenByItems, setData

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.phloc.commons.tree.withid.ITreeItemWithID

containsChildItemWithDataID, createChildItem, createChildItem, getAllChildDataIDs, getChildItemOfDataID, getFactory, getID, getParentID, internalAddChild, removeAllChildren, removeChild, reorderChildrenByItems

Methods inherited from interface com.phloc.commons.tree.IBasicTreeItem

changeParent, getAllChildDatas, getData, getParentData, isRootItem, isSameOrChildOf, setData

Methods inherited from interface com.phloc.commons.parent.IHasParent

getParent

Methods inherited from interface com.phloc.commons.parent.IHasChildrenSorted

getChildAtIndex, getChildren, getFirstChild, getLastChild

Methods inherited from interface com.phloc.commons.parent.IHasChildren

getChildCount, hasChildren

Constructor Detail

BasicFolderTreeItem

public BasicFolderTreeItem(@Nonnull
                   IFolderTreeItemFactory<KEYTYPE,DATATYPE,COLLTYPE,ITEMTYPE> aFactory)

Constructor for root object

Parameters:

aFactory - The item factory to use.

BasicFolderTreeItem

public BasicFolderTreeItem(@Nonnull
                   IFolderTreeItemFactory<KEYTYPE,DATATYPE,COLLTYPE,ITEMTYPE> aFactory,
                   @Nullable
                   KEYTYPE aDataID)

Constructor for root object

Parameters:

aFactory - The item factory to use.

aDataID - The data ID of the root item.

BasicFolderTreeItem

public BasicFolderTreeItem(@Nonnull
                   ITEMTYPE aParent,
                   @Nonnull
                   KEYTYPE aDataID)

Constructor for normal elements

Parameters:

aParent - Parent item. May never be null since only the root has no parent.

aDataID - The ID of the new item. May not be null.

Method Detail

getGlobalUniqueDataID

@Nonnull
public final KEYTYPE getGlobalUniqueDataID()

Specified by:

getGlobalUniqueDataID in interface IFolderTreeItem<KEYTYPE,DATATYPE,COLLTYPE extends Collection<DATATYPE>,ITEMTYPE extends BasicFolderTreeItem<KEYTYPE,DATATYPE,COLLTYPE,ITEMTYPE>>

Returns:

The globally unique ID of this folder. This can e.g. be an aggregation of the ID with a separator and the parent's unique name.

equals

public boolean equals(Object o)

Overrides:

equals in class BasicTreeItemWithID<KEYTYPE,COLLTYPE extends Collection<DATATYPE>,ITEMTYPE extends BasicFolderTreeItem<KEYTYPE,DATATYPE,COLLTYPE,ITEMTYPE>>

hashCode

public int hashCode()

Overrides:

hashCode in class BasicTreeItemWithID<KEYTYPE,COLLTYPE extends Collection<DATATYPE>,ITEMTYPE extends BasicFolderTreeItem<KEYTYPE,DATATYPE,COLLTYPE,ITEMTYPE>>

toString

public String toString()

Overrides:

toString in class BasicTreeItemWithID<KEYTYPE,COLLTYPE extends Collection<DATATYPE>,ITEMTYPE extends BasicFolderTreeItem<KEYTYPE,DATATYPE,COLLTYPE,ITEMTYPE>>