com.helger.commons.tree.withid.folder

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

java.lang.Object

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

com.helger.commons.tree.withid.folder.AbstractFolderTreeItemFactory<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:

IHierarchicalFactoryWithParameter<ITEMTYPE,KEYTYPE>, IHierarchicalRootFactory<ITEMTYPE>, IFolderTreeItemFactory<KEYTYPE,DATATYPE,COLLTYPE,ITEMTYPE>, ITreeItemWithIDFactory<KEYTYPE,COLLTYPE,ITEMTYPE>, ITreeItemWithUniqueIDFactory<KEYTYPE,COLLTYPE,ITEMTYPE>

Direct Known Subclasses:

DefaultFolderTreeItemFactory

@NotThreadSafe
public abstract class AbstractFolderTreeItemFactory<KEYTYPE,DATATYPE,COLLTYPE extends Collection<DATATYPE>,ITEMTYPE extends BasicFolderTreeItem<KEYTYPE,DATATYPE,COLLTYPE,ITEMTYPE>>
extends AbstractTreeItemWithUniqueIDFactory<KEYTYPE,COLLTYPE,ITEMTYPE>
implements IFolderTreeItemFactory<KEYTYPE,DATATYPE,COLLTYPE,ITEMTYPE>

The default folder tree item factory implementation.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
AbstractFolderTreeItemFactory(IAggregator<KEYTYPE,KEYTYPE> aKeyCombinator)

Method Summary

Modifier and Type	Method and Description
ITEMTYPE	createRoot() Create the root object.
boolean	equals(Object o)
IAggregator<KEYTYPE,KEYTYPE>	getKeyCombinator()
int	hashCode()
protected abstract ITEMTYPE	internalCreateRoot()
protected KEYTYPE	internalGetItemID(ITEMTYPE aItem) Get the ID of the passed tree item to use for internal storage.
String	toString()

Methods inherited from class com.helger.commons.tree.withid.unique.AbstractTreeItemWithUniqueIDFactory

addToItemStore, containsItemWithDataID, create, getAllItemDatas, getAllItems, getItemCount, getItemOfDataID, internalCreate, onAddItem, onRemoveItem

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.commons.tree.withid.unique.ITreeItemWithUniqueIDFactory

containsItemWithDataID, getAllItemDatas, getAllItems, getItemCount, getItemOfDataID

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

create, onAddItem, onRemoveItem

Constructor Detail

AbstractFolderTreeItemFactory

public AbstractFolderTreeItemFactory(@Nullable
                                     IAggregator<KEYTYPE,KEYTYPE> aKeyCombinator)

Method Detail

internalGetItemID

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

Description copied from class: AbstractTreeItemWithUniqueIDFactory

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

Overrides:

internalGetItemID in class AbstractTreeItemWithUniqueIDFactory<KEYTYPE,COLLTYPE extends Collection<DATATYPE>,ITEMTYPE extends BasicFolderTreeItem<KEYTYPE,DATATYPE,COLLTYPE,ITEMTYPE>>

Parameters:

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

Returns:

The ID of the item

getKeyCombinator

@Nullable
public final IAggregator<KEYTYPE,KEYTYPE> getKeyCombinator()

Specified by:

getKeyCombinator in interface IFolderTreeItemFactory<KEYTYPE,DATATYPE,COLLTYPE extends Collection<DATATYPE>,ITEMTYPE extends BasicFolderTreeItem<KEYTYPE,DATATYPE,COLLTYPE,ITEMTYPE>>

Returns:

The key combinator to be used to create global unique IDs.

internalCreateRoot

@Nonnull
protected abstract ITEMTYPE internalCreateRoot()

createRoot

@Nonnull
public final ITEMTYPE createRoot()

Description copied from interface: ITreeItemWithIDFactory

Create the root object. May be called only once.

Specified by:

createRoot in interface IHierarchicalRootFactory<ITEMTYPE extends BasicFolderTreeItem<KEYTYPE,DATATYPE,COLLTYPE,ITEMTYPE>>

Specified by:

createRoot in interface ITreeItemWithIDFactory<KEYTYPE,COLLTYPE extends Collection<DATATYPE>,ITEMTYPE extends BasicFolderTreeItem<KEYTYPE,DATATYPE,COLLTYPE,ITEMTYPE>>

Returns:

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

equals

public boolean equals(Object o)

Overrides:

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

hashCode

public int hashCode()

Overrides:

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

toString

public String toString()

Overrides:

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