com.helger.commons.tree.withid.folder

Interface IFolderTreeItem<KEYTYPE,DATATYPE,COLLTYPE extends Collection<DATATYPE>,ITEMTYPE extends IFolderTreeItem<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 Superinterfaces:

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

All Known Implementing Classes:

BasicFolderTreeItem, DefaultFolderTreeItem

public interface IFolderTreeItem<KEYTYPE,DATATYPE,COLLTYPE extends Collection<DATATYPE>,ITEMTYPE extends IFolderTreeItem<KEYTYPE,DATATYPE,COLLTYPE,ITEMTYPE>>
extends ITreeItemWithID<KEYTYPE,COLLTYPE,ITEMTYPE>

This interface represents a single folder within a directory tree. Each folder has a list of file items (or leaves).

Author:

Philip Helger

Method Summary

Methods

Modifier and Type	Method and Description
KEYTYPE	getGlobalUniqueDataID()

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

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

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

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

Methods inherited from interface com.helger.commons.hierarchy.IHasParent

getParent

Methods inherited from interface com.helger.commons.hierarchy.IHasChildrenSorted

getAllChildren, getChildAtIndex, getFirstChild, getLastChild

Methods inherited from interface com.helger.commons.hierarchy.IHasChildren

getChildCount, hasChildren

Method Detail

getGlobalUniqueDataID

@Nonnull
KEYTYPE getGlobalUniqueDataID()

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.