com.helger.commons.scope.singletons

Class AbstractSessionSingletonTreeWithUniqueID<KEYTYPE,VALUETYPE>

java.lang.Object

com.helger.commons.scope.singleton.AbstractSingleton

com.helger.commons.scope.singleton.AbstractSessionSingleton

com.helger.commons.scope.singletons.AbstractSessionSingletonTreeWithUniqueID<KEYTYPE,VALUETYPE>

Type Parameters:

KEYTYPE - Tree key type

VALUETYPE - Tree value type

All Implemented Interfaces:

IChildrenProvider<DefaultTreeItemWithID<KEYTYPE,VALUETYPE>>, IChildrenProviderWithID<KEYTYPE,DefaultTreeItemWithID<KEYTYPE,VALUETYPE>>, IHasChildren<DefaultTreeItemWithID<KEYTYPE,VALUETYPE>>, IScopeDestructionAware, IBasicTree<VALUETYPE,DefaultTreeItemWithID<KEYTYPE,VALUETYPE>>, ITreeWithID<KEYTYPE,VALUETYPE,DefaultTreeItemWithID<KEYTYPE,VALUETYPE>>, ITreeWithGlobalUniqueID<KEYTYPE,VALUETYPE,DefaultTreeItemWithID<KEYTYPE,VALUETYPE>>, Serializable

public abstract class AbstractSessionSingletonTreeWithUniqueID<KEYTYPE,VALUETYPE>
extends AbstractSessionSingleton
implements ITreeWithGlobalUniqueID<KEYTYPE,VALUETYPE,DefaultTreeItemWithID<KEYTYPE,VALUETYPE>>

Represents a global singleton tree with a unique ID. It basically is a AbstractSessionSingleton wrapping a DefaultTreeWithGlobalUniqueID with the same API.

Author:

Philip Helger

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected DefaultTreeWithGlobalUniqueID<KEYTYPE,VALUETYPE>	m_aTree

Fields inherited from class com.helger.commons.scope.singleton.AbstractSingleton

m_aRWLock

Constructor Summary

Constructors

Constructor and Description
AbstractSessionSingletonTreeWithUniqueID()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	containsItemWithID(KEYTYPE aDataID) Check if a tree item corresponding to the given ID is present.
Collection<? extends DefaultTreeItemWithID<KEYTYPE,VALUETYPE>>	getAllChildren()
Collection<? extends DefaultTreeItemWithID<KEYTYPE,VALUETYPE>>	getAllChildren(DefaultTreeItemWithID<KEYTYPE,VALUETYPE> aCurrent) Get the children of the passed object.
Collection<VALUETYPE>	getAllItemDatas()
Collection<DefaultTreeItemWithID<KEYTYPE,VALUETYPE>>	getAllItems()
int	getChildCount()
int	getChildCount(DefaultTreeItemWithID<KEYTYPE,VALUETYPE> aCurrent)
DefaultTreeItemWithID<KEYTYPE,VALUETYPE>	getChildWithID(DefaultTreeItemWithID<KEYTYPE,VALUETYPE> aCurrent, KEYTYPE aID) Retrieve the objects with the passed ID or null if no such object.
int	getItemCount()
VALUETYPE	getItemDataWithID(KEYTYPE aDataID) Get the data of the tree item that corresponds to the given ID.
DefaultTreeItemWithID<KEYTYPE,VALUETYPE>	getItemWithID(KEYTYPE aDataID) Get the ITreeItemWithID that corresponds to the given ID.
DefaultTreeItemWithID<KEYTYPE,VALUETYPE>	getRootItem()
boolean	hasChildren()
boolean	hasChildren(DefaultTreeItemWithID<KEYTYPE,VALUETYPE> aCurrent) Check if an item has children.
boolean	isItemSameOrDescendant(KEYTYPE aParentItemID, KEYTYPE aChildItemID) Check if one item is equal or a child of the other item.
EChange	removeItemWithID(KEYTYPE aDataID) Remove the item with the specified ID

Methods inherited from class com.helger.commons.scope.singleton.AbstractSessionSingleton

getAllSessionSingletons, getSessionSingleton, getSessionSingletonIfInstantiated, isSessionSingletonInstantiated

Methods inherited from class com.helger.commons.scope.singleton.AbstractSingleton

getAllSingletons, getSingleton, getSingletonIfInstantiated, getSingletonScopeKey, isDestroyed, isInDestruction, isInInstantiation, isInPreDestruction, isInstantiated, isSingletonInstantiated, isUsableObject, onAfterInstantiation, onBeforeDestroy, onBeforeScopeDestruction, onDestroy, onScopeDestruction, readAbstractSingletonFields, setDestroyed, setInDestruction, setInInstantiation, setInPreDestruction, setInstantiated, toString, writeAbstractSingletonFields

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

m_aTree

protected final DefaultTreeWithGlobalUniqueID<KEYTYPE,VALUETYPE> m_aTree

Constructor Detail

AbstractSessionSingletonTreeWithUniqueID

public AbstractSessionSingletonTreeWithUniqueID()

Method Detail

hasChildren

public final boolean hasChildren()

Specified by:

hasChildren in interface IHasChildren<DefaultTreeItemWithID<KEYTYPE,VALUETYPE>>

Returns:

true if this item has direct children, false otherwise.

getChildCount

@Nonnegative
public int getChildCount()

Specified by:

getChildCount in interface IHasChildren<DefaultTreeItemWithID<KEYTYPE,VALUETYPE>>

Returns:

The number of contained direct children. Always ≥ 0.

getAllChildren

@Nonnull
@ReturnsMutableCopy
public final Collection<? extends DefaultTreeItemWithID<KEYTYPE,VALUETYPE>> getAllChildren()

Specified by:

getAllChildren in interface IHasChildren<DefaultTreeItemWithID<KEYTYPE,VALUETYPE>>

Returns:

A collection of all direct child elements. May be null .

getRootItem

@Nonnull
public DefaultTreeItemWithID<KEYTYPE,VALUETYPE> getRootItem()

Specified by:

getRootItem in interface IBasicTree<VALUETYPE,DefaultTreeItemWithID<KEYTYPE,VALUETYPE>>

Returns:

The root item of the tree. Never null. The root item should not be displayed but it is the parent node of all displayed root items and therefore cannot be removed.

getChildWithID

@Nullable
public DefaultTreeItemWithID<KEYTYPE,VALUETYPE> getChildWithID(@Nullable
                                                               DefaultTreeItemWithID<KEYTYPE,VALUETYPE> aCurrent,
                                                               @Nullable
                                                               KEYTYPE aID)

Description copied from interface: IChildrenProviderWithID

Retrieve the objects with the passed ID or null if no such object.

Specified by:

getChildWithID in interface IChildrenProviderWithID<KEYTYPE,DefaultTreeItemWithID<KEYTYPE,VALUETYPE>>

Parameters:

aCurrent - The object to determine the children of. No null or non- null constraint possible.

aID - the ID of the object in question. No null or non- null constraint possible.

Returns:

the object with the passed ID or null

hasChildren

public boolean hasChildren(@Nullable
                  DefaultTreeItemWithID<KEYTYPE,VALUETYPE> aCurrent)

Description copied from interface: IChildrenProvider

Check if an item has children.

Specified by:

hasChildren in interface IChildrenProvider<DefaultTreeItemWithID<KEYTYPE,VALUETYPE>>

Parameters:

aCurrent - The object to determine the children of. No null or non- null constraint possible.

Returns:

true if this item has children, false otherwise.

getChildCount

@Nonnegative
public int getChildCount(@Nullable
                            DefaultTreeItemWithID<KEYTYPE,VALUETYPE> aCurrent)

Specified by:

getChildCount in interface IChildrenProvider<DefaultTreeItemWithID<KEYTYPE,VALUETYPE>>

Parameters:

aCurrent - The object to determine the children count of. No null or non- null constraint possible.

Returns:

The number of contained direct children. Always ≥ 0.

getAllChildren

@Nullable
public Collection<? extends DefaultTreeItemWithID<KEYTYPE,VALUETYPE>> getAllChildren(@Nullable
                                                                                     DefaultTreeItemWithID<KEYTYPE,VALUETYPE> aCurrent)

Description copied from interface: IChildrenProvider

Get the children of the passed object.

Specified by:

getAllChildren in interface IChildrenProvider<DefaultTreeItemWithID<KEYTYPE,VALUETYPE>>

Parameters:

aCurrent - The object to determine the children of. No null or non-null constraint possible.

Returns:

The child objects, or null if there are no children. If null is passed, the resolver is expected to return any possible top level (root) elements. This method may NOT return null if the call to IChildrenProvider.hasChildren(Object) with the same object returned true.

getItemWithID

@Nullable
public DefaultTreeItemWithID<KEYTYPE,VALUETYPE> getItemWithID(@Nullable
                                                              KEYTYPE aDataID)

Description copied from interface: ITreeWithGlobalUniqueID

Get the ITreeItemWithID that corresponds to the given ID.

Specified by:

getItemWithID in interface ITreeWithGlobalUniqueID<KEYTYPE,VALUETYPE,DefaultTreeItemWithID<KEYTYPE,VALUETYPE>>

Parameters:

aDataID - The ID of the tree item to search.

Returns:

null if no such tree item exists.

getItemCount

@Nonnegative
public int getItemCount()

Specified by:

getItemCount in interface ITreeWithGlobalUniqueID<KEYTYPE,VALUETYPE,DefaultTreeItemWithID<KEYTYPE,VALUETYPE>>

Returns:

The number of all contained items. Always ≥ 0.

getAllItems

@Nonnull
public Collection<DefaultTreeItemWithID<KEYTYPE,VALUETYPE>> getAllItems()

Specified by:

getAllItems in interface ITreeWithGlobalUniqueID<KEYTYPE,VALUETYPE,DefaultTreeItemWithID<KEYTYPE,VALUETYPE>>

Returns:

A non-null collection of all items.

isItemSameOrDescendant

public boolean isItemSameOrDescendant(@Nullable
                             KEYTYPE aParentItemID,
                             @Nullable
                             KEYTYPE aChildItemID)

Description copied from interface: ITreeWithGlobalUniqueID

Check if one item is equal or a child of the other item. This relationship is checked not only for direct children but for all levels.

Specified by:

isItemSameOrDescendant in interface ITreeWithGlobalUniqueID<KEYTYPE,VALUETYPE,DefaultTreeItemWithID<KEYTYPE,VALUETYPE>>

Parameters:

aParentItemID - The parent item ID to a validate.

aChildItemID - The item ID to check whether it is a child of the passed parent folder.

Returns:

true if the child item is the same or a child of the parent item, false if one of the IDs could not be resolved or they are not in a parent-child-relationship.

containsItemWithID

public boolean containsItemWithID(@Nullable
                         KEYTYPE aDataID)

Description copied from interface: ITreeWithGlobalUniqueID

Check if a tree item corresponding to the given ID is present.

Specified by:

containsItemWithID in interface ITreeWithGlobalUniqueID<KEYTYPE,VALUETYPE,DefaultTreeItemWithID<KEYTYPE,VALUETYPE>>

Parameters:

aDataID - The ID of the tree item to search.

Returns:

true if such an item is present

getItemDataWithID

@Nullable
public VALUETYPE getItemDataWithID(@Nullable
                                   KEYTYPE aDataID)

Description copied from interface: ITreeWithGlobalUniqueID

Get the data of the tree item that corresponds to the given ID.

Specified by:

getItemDataWithID in interface ITreeWithGlobalUniqueID<KEYTYPE,VALUETYPE,DefaultTreeItemWithID<KEYTYPE,VALUETYPE>>

Parameters:

aDataID - The ID of the tree item to search.

Returns:

null if no such tree item exists.

getAllItemDatas

@Nonnull
@ReturnsMutableCopy
public Collection<VALUETYPE> getAllItemDatas()

Specified by:

getAllItemDatas in interface ITreeWithGlobalUniqueID<KEYTYPE,VALUETYPE,DefaultTreeItemWithID<KEYTYPE,VALUETYPE>>

Returns:

A non-null collection of all item datas.

removeItemWithID

@Nonnull
public EChange removeItemWithID(@Nullable
                               KEYTYPE aDataID)

Description copied from interface: ITreeWithGlobalUniqueID

Remove the item with the specified ID

Specified by:

removeItemWithID in interface ITreeWithGlobalUniqueID<KEYTYPE,VALUETYPE,DefaultTreeItemWithID<KEYTYPE,VALUETYPE>>

Parameters:

aDataID - The ID of the item to be removed

Returns:

EChange.CHANGED if the item was removed, EChange.UNCHANGED otherwise. Never null.