com.helger.commons.tree.withid

Interface ITreeItemWithIDFactory<KEYTYPE,DATATYPE,ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>>

Type Parameters:

KEYTYPE - The key type.

DATATYPE - The value type to be contained in tree items.

ITEMTYPE - tree item type

All Superinterfaces:

IHierarchicalFactoryWithParameter<ITEMTYPE,KEYTYPE>, IHierarchicalRootFactory<ITEMTYPE>

All Known Subinterfaces:

IFolderTreeItemFactory<KEYTYPE,DATATYPE,COLLTYPE,ITEMTYPE>, ITreeItemWithUniqueIDFactory<KEYTYPE,DATATYPE,ITEMTYPE>

All Known Implementing Classes:

AbstractFolderTreeItemFactory, AbstractTreeItemWithIDFactory, AbstractTreeItemWithUniqueIDFactory, DefaultFolderTreeItemFactory, DefaultTreeItemWithIDFactory, DefaultTreeItemWithUniqueIDFactory

public interface ITreeItemWithIDFactory<KEYTYPE,DATATYPE,ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>>
extends IHierarchicalFactoryWithParameter<ITEMTYPE,KEYTYPE>, IHierarchicalRootFactory<ITEMTYPE>

A factory interface that creates tree items.

Author:

Philip Helger

Method Summary

Modifier and Type	Method and Description
ITEMTYPE	create(ITEMTYPE aParent, KEYTYPE aDataID) Create an object of the desired type.
ITEMTYPE	createRoot() Create the root object.
void	onAddItem(ITEMTYPE aItem) To be called once a tree item is added to the owning tree.
void	onRemoveItem(ITEMTYPE aItem) To be called once a tree item is removed from the owning tree.

Method Detail

createRoot

@Nonnull
ITEMTYPE createRoot()

Create the root object. May be called only once.

Specified by:

createRoot in interface IHierarchicalRootFactory<ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>>

Returns:

The root object. May be null depending on the implementation.

create

ITEMTYPE create(@Nonnull
                ITEMTYPE aParent,
                @Nonnull
                KEYTYPE aDataID)

Create an object of the desired type.

Specified by:

create in interface IHierarchicalFactoryWithParameter<ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>,KEYTYPE>

Parameters:

aParent - The parent item to use. May be null depending on the implementation.

aDataID - The parameter to be passed. May be null depending on the implementation.

Returns:

The created object. May be null depending on the implementation.

onRemoveItem

void onRemoveItem(@Nonnull
                  ITEMTYPE aItem)

To be called once a tree item is removed from the owning tree. This method is mainly important for the tree with globally unique IDs.

Parameters:

aItem - The item that was removed.

onAddItem

void onAddItem(@Nonnull
               ITEMTYPE aItem)

To be called once a tree item is added to the owning tree. This method is mainly important for the tree with globally unique IDs.

Parameters:

aItem - The item that was added.