com.helger.commons.tree.withid.unique

Class AbstractTreeItemWithUniqueIDFactory<KEYTYPE,DATATYPE,ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>>

java.lang.Object

com.helger.commons.tree.withid.unique.AbstractTreeItemWithUniqueIDFactory<KEYTYPE,DATATYPE,ITEMTYPE>

Type Parameters:

KEYTYPE - The key type.

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

ITEMTYPE - tree item type

All Implemented Interfaces:

IFactoryWithTwoParameters<ITEMTYPE,ITEMTYPE,KEYTYPE>, IHierarchicalFactoryWithParameter<ITEMTYPE,KEYTYPE>, IHierarchicalRootFactory<ITEMTYPE>, ITreeItemWithIDFactory<KEYTYPE,DATATYPE,ITEMTYPE>, ITreeItemWithUniqueIDFactory<KEYTYPE,DATATYPE,ITEMTYPE>

Direct Known Subclasses:

AbstractFolderTreeItemFactory, DefaultTreeItemWithUniqueIDFactory

@NotThreadSafe
public abstract class AbstractTreeItemWithUniqueIDFactory<KEYTYPE,DATATYPE,ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>>
extends Object
implements ITreeItemWithUniqueIDFactory<KEYTYPE,DATATYPE,ITEMTYPE>

An abstract tree item factory that maintains a unique ID over all items. It does not put the root item in the data store!

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
AbstractTreeItemWithUniqueIDFactory()
AbstractTreeItemWithUniqueIDFactory(Map<KEYTYPE,ITEMTYPE> aItemStore)

Method Summary

Modifier and Type	Method and Description
protected ITEMTYPE	addToItemStore(KEYTYPE aDataID, ITEMTYPE aItem)
boolean	containsItemWithDataID(KEYTYPE aDataID) Check if an item with the given ID is contained.
ITEMTYPE	create(ITEMTYPE aParent, KEYTYPE aDataID) Create an object of the desired type.
boolean	equals(Object o)
List<DATATYPE>	getAllItemDatas()
List<ITEMTYPE>	getAllItems()
int	getItemCount()
ITEMTYPE	getItemOfDataID(KEYTYPE aDataID) Try to retrieve the stored item with the given ID.
int	hashCode()
protected abstract ITEMTYPE	internalCreate(ITEMTYPE aParent, KEYTYPE aDataID)
protected KEYTYPE	internalGetItemID(ITEMTYPE aItem) Get the ID of the passed tree item to use for internal storage.
void	onAddItem(ITEMTYPE aTreeItem) To be called once a tree item is added to the owning tree.
void	onRemoveItem(ITEMTYPE aTreeItem) To be called once a tree item is removed from the owning tree.
String	toString()

Methods inherited from class java.lang.Object

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

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

createRoot

Constructor Detail

AbstractTreeItemWithUniqueIDFactory

public AbstractTreeItemWithUniqueIDFactory()

AbstractTreeItemWithUniqueIDFactory

public AbstractTreeItemWithUniqueIDFactory(@Nonnull
                                           Map<KEYTYPE,ITEMTYPE> aItemStore)

Method Detail

addToItemStore

@Nonnull
protected final ITEMTYPE addToItemStore(@Nonnull
                                                  KEYTYPE aDataID,
                                                  @Nonnull
                                                  ITEMTYPE aItem)

internalCreate

@Nonnull
protected abstract ITEMTYPE internalCreate(@Nonnull
                                                     ITEMTYPE aParent,
                                                     @Nonnull
                                                     KEYTYPE aDataID)

internalGetItemID

@Nonnull
 @OverrideOnDemand
protected KEYTYPE internalGetItemID(@Nonnull
                                                                  ITEMTYPE aItem)

Get the ID of the passed tree item to use for internal storage.

Parameters:

aItem - The item who's ID is to be resolved.

Returns:

The ID of the item

create

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

Description copied from interface: ITreeItemWithIDFactory

Create an object of the desired type.

Specified by:

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

Specified by:

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

Specified by:

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

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

public final void onRemoveItem(@Nonnull
                               ITEMTYPE aTreeItem)

Description copied from interface: ITreeItemWithIDFactory

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.

Specified by:

onRemoveItem in interface ITreeItemWithIDFactory<KEYTYPE,DATATYPE,ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>>

Parameters:

aTreeItem - The item that was removed.

onAddItem

public final void onAddItem(@Nonnull
                            ITEMTYPE aTreeItem)

Description copied from interface: ITreeItemWithIDFactory

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.

Specified by:

onAddItem in interface ITreeItemWithIDFactory<KEYTYPE,DATATYPE,ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>>

Parameters:

aTreeItem - The item that was added.

containsItemWithDataID

public final boolean containsItemWithDataID(@Nullable
                                            KEYTYPE aDataID)

Description copied from interface: ITreeItemWithUniqueIDFactory

Check if an item with the given ID is contained.

Specified by:

containsItemWithDataID in interface ITreeItemWithUniqueIDFactory<KEYTYPE,DATATYPE,ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>>

Parameters:

aDataID - The data ID to look up.

Returns:

true if such an item is contained, false otherwise.

getItemOfDataID

@Nullable
public final ITEMTYPE getItemOfDataID(@Nullable
                                                 KEYTYPE aDataID)

Description copied from interface: ITreeItemWithUniqueIDFactory

Try to retrieve the stored item with the given ID.

Specified by:

getItemOfDataID in interface ITreeItemWithUniqueIDFactory<KEYTYPE,DATATYPE,ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>>

Parameters:

aDataID - The data ID to look up.

Returns:

null if no such item is contained, the item otherwise.

getItemCount

@Nonnegative
public final int getItemCount()

Specified by:

getItemCount in interface ITreeItemWithUniqueIDFactory<KEYTYPE,DATATYPE,ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>>

Returns:

The number of all contained items. Always ≥ 0.

getAllItems

@Nonnull
 @ReturnsMutableCopy
public final List<ITEMTYPE> getAllItems()

Specified by:

getAllItems in interface ITreeItemWithUniqueIDFactory<KEYTYPE,DATATYPE,ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>>

Returns:

A collection that contains all items created by this factory instance.

getAllItemDatas

@Nonnull
 @ReturnsMutableCopy
public final List<DATATYPE> getAllItemDatas()

Specified by:

getAllItemDatas in interface ITreeItemWithUniqueIDFactory<KEYTYPE,DATATYPE,ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>>

Returns:

A collection that contains all item datas created by this factory instance.

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