com.helger.tree.singleton

Interface ITreeWithUniqueIDProxy<KEYTYPE,VALUETYPE>

Type Parameters:

KEYTYPE - Tree key type

VALUETYPE - Tree value type

All Superinterfaces:

IBasicTree<VALUETYPE,DefaultTreeItemWithID<KEYTYPE,VALUETYPE>>, com.helger.commons.hierarchy.IChildrenProvider<DefaultTreeItemWithID<KEYTYPE,VALUETYPE>>, com.helger.commons.hierarchy.IChildrenProviderWithID<KEYTYPE,DefaultTreeItemWithID<KEYTYPE,VALUETYPE>>, com.helger.commons.hierarchy.IHasChildren<DefaultTreeItemWithID<KEYTYPE,VALUETYPE>>, ITreeWithGlobalUniqueID<KEYTYPE,VALUETYPE,DefaultTreeItemWithID<KEYTYPE,VALUETYPE>>, ITreeWithID<KEYTYPE,VALUETYPE,DefaultTreeItemWithID<KEYTYPE,VALUETYPE>>

All Known Implementing Classes:

AbstractGlobalSingletonTreeWithUniqueID, AbstractRequestSingletonTreeWithUniqueID, AbstractSessionSingletonTreeWithUniqueID

public interface ITreeWithUniqueIDProxy<KEYTYPE,VALUETYPE>
extends ITreeWithGlobalUniqueID<KEYTYPE,VALUETYPE,DefaultTreeItemWithID<KEYTYPE,VALUETYPE>>

Default proxy interface for ITreeWithGlobalUniqueID.

Author:

Philip Helger

Method Summary

Modifier and Type	Method and Description
default boolean	containsItemWithID(KEYTYPE aDataID) Check if a tree item corresponding to the given ID is present.
default void	forAllChildren(Consumer<? super DefaultTreeItemWithID<KEYTYPE,VALUETYPE>> aConsumer)
default void	forAllChildren(Predicate<? super DefaultTreeItemWithID<KEYTYPE,VALUETYPE>> aFilter, Consumer<? super DefaultTreeItemWithID<KEYTYPE,VALUETYPE>> aConsumer)
default <DSTTYPE> void	forAllChildrenMapped(Predicate<? super DefaultTreeItemWithID<KEYTYPE,VALUETYPE>> aFilter, Function<? super DefaultTreeItemWithID<KEYTYPE,VALUETYPE>,? extends DSTTYPE> aMapper, Consumer<? super DSTTYPE> aConsumer)
default com.helger.commons.collection.impl.ICommonsCollection<DefaultTreeItemWithID<KEYTYPE,VALUETYPE>>	getAllChildren()
default com.helger.commons.collection.impl.ICommonsCollection<? extends DefaultTreeItemWithID<KEYTYPE,VALUETYPE>>	getAllChildren(DefaultTreeItemWithID<KEYTYPE,VALUETYPE> aCurrent)
default com.helger.commons.collection.impl.ICommonsCollection<VALUETYPE>	getAllItemDatas()
default com.helger.commons.collection.impl.ICommonsCollection<DefaultTreeItemWithID<KEYTYPE,VALUETYPE>>	getAllItems()
default int	getChildCount()
default int	getChildCount(DefaultTreeItemWithID<KEYTYPE,VALUETYPE> aCurrent)
default com.helger.commons.collection.impl.ICommonsIterable<DefaultTreeItemWithID<KEYTYPE,VALUETYPE>>	getChildren()
default DefaultTreeItemWithID<KEYTYPE,VALUETYPE>	getChildWithID(DefaultTreeItemWithID<KEYTYPE,VALUETYPE> aCurrent, KEYTYPE aID)
default int	getItemCount()
default VALUETYPE	getItemDataWithID(KEYTYPE aDataID) Get the data of the tree item that corresponds to the given ID.
default DefaultTreeItemWithID<KEYTYPE,VALUETYPE>	getItemWithID(KEYTYPE aDataID) Get the ITreeItemWithID that corresponds to the given ID.
DefaultTreeWithGlobalUniqueID<KEYTYPE,VALUETYPE>	getProxyTree()
default DefaultTreeItemWithID<KEYTYPE,VALUETYPE>	getRootItem()
default boolean	hasChildren()
default boolean	hasChildren(DefaultTreeItemWithID<KEYTYPE,VALUETYPE> aCurrent)
default boolean	hasNoChildren()
default boolean	hasNoChildren(DefaultTreeItemWithID<KEYTYPE,VALUETYPE> aCurrent)
default boolean	isItemSameOrDescendant(KEYTYPE aParentItemID, KEYTYPE aChildItemID) Check if one item is equal or a child of the other item.
default com.helger.commons.state.EChange	removeItemWithID(KEYTYPE aDataID) Remove the item with the specified ID

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

forAllChildrenBreakable

Method Detail

getProxyTree

@Nonnull
DefaultTreeWithGlobalUniqueID<KEYTYPE,VALUETYPE> getProxyTree()

hasChildren

default boolean hasChildren()

Specified by:

hasChildren in interface com.helger.commons.hierarchy.IHasChildren<DefaultTreeItemWithID<KEYTYPE,VALUETYPE>>

hasNoChildren

default boolean hasNoChildren()

Specified by:

hasNoChildren in interface com.helger.commons.hierarchy.IHasChildren<DefaultTreeItemWithID<KEYTYPE,VALUETYPE>>

getChildCount

@Nonnegative
default int getChildCount()

Specified by:

getChildCount in interface com.helger.commons.hierarchy.IHasChildren<DefaultTreeItemWithID<KEYTYPE,VALUETYPE>>

getAllChildren

@Nonnull
 @ReturnsMutableCopy
default com.helger.commons.collection.impl.ICommonsCollection<DefaultTreeItemWithID<KEYTYPE,VALUETYPE>> getAllChildren()

Specified by:

getAllChildren in interface com.helger.commons.hierarchy.IHasChildren<DefaultTreeItemWithID<KEYTYPE,VALUETYPE>>

getChildren

@Nullable
default com.helger.commons.collection.impl.ICommonsIterable<DefaultTreeItemWithID<KEYTYPE,VALUETYPE>> getChildren()

Specified by:

getChildren in interface com.helger.commons.hierarchy.IHasChildren<DefaultTreeItemWithID<KEYTYPE,VALUETYPE>>

forAllChildren

default void forAllChildren(@Nonnull
                            Consumer<? super DefaultTreeItemWithID<KEYTYPE,VALUETYPE>> aConsumer)

Specified by:

forAllChildren in interface com.helger.commons.hierarchy.IHasChildren<DefaultTreeItemWithID<KEYTYPE,VALUETYPE>>

forAllChildren

default void forAllChildren(@Nonnull
                            Predicate<? super DefaultTreeItemWithID<KEYTYPE,VALUETYPE>> aFilter,
                            @Nonnull
                            Consumer<? super DefaultTreeItemWithID<KEYTYPE,VALUETYPE>> aConsumer)

Specified by:

forAllChildren in interface com.helger.commons.hierarchy.IHasChildren<DefaultTreeItemWithID<KEYTYPE,VALUETYPE>>

forAllChildrenMapped

default <DSTTYPE> void forAllChildrenMapped(@Nonnull
                                            Predicate<? super DefaultTreeItemWithID<KEYTYPE,VALUETYPE>> aFilter,
                                            @Nonnull
                                            Function<? super DefaultTreeItemWithID<KEYTYPE,VALUETYPE>,? extends DSTTYPE> aMapper,
                                            @Nonnull
                                            Consumer<? super DSTTYPE> aConsumer)

Specified by:

forAllChildrenMapped in interface com.helger.commons.hierarchy.IHasChildren<DefaultTreeItemWithID<KEYTYPE,VALUETYPE>>

getRootItem

@Nonnull
default 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
default DefaultTreeItemWithID<KEYTYPE,VALUETYPE> getChildWithID(@Nullable
                                                                           DefaultTreeItemWithID<KEYTYPE,VALUETYPE> aCurrent,
                                                                           @Nullable
                                                                           KEYTYPE aID)

Specified by:

getChildWithID in interface com.helger.commons.hierarchy.IChildrenProviderWithID<KEYTYPE,DefaultTreeItemWithID<KEYTYPE,VALUETYPE>>

hasChildren

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

Specified by:

hasChildren in interface com.helger.commons.hierarchy.IChildrenProvider<DefaultTreeItemWithID<KEYTYPE,VALUETYPE>>

hasNoChildren

default boolean hasNoChildren(@Nullable
                              DefaultTreeItemWithID<KEYTYPE,VALUETYPE> aCurrent)

Specified by:

hasNoChildren in interface com.helger.commons.hierarchy.IChildrenProvider<DefaultTreeItemWithID<KEYTYPE,VALUETYPE>>

getChildCount

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

Specified by:

getChildCount in interface com.helger.commons.hierarchy.IChildrenProvider<DefaultTreeItemWithID<KEYTYPE,VALUETYPE>>

getAllChildren

@Nullable
default com.helger.commons.collection.impl.ICommonsCollection<? extends DefaultTreeItemWithID<KEYTYPE,VALUETYPE>> getAllChildren(@Nullable
                                                                                                                                            DefaultTreeItemWithID<KEYTYPE,VALUETYPE> aCurrent)

Specified by:

getAllChildren in interface com.helger.commons.hierarchy.IChildrenProvider<DefaultTreeItemWithID<KEYTYPE,VALUETYPE>>

getItemWithID

@Nullable
default 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
default int getItemCount()

Specified by:

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

Returns:

The number of all contained items. Always ≥ 0.

getAllItems

@Nonnull
default com.helger.commons.collection.impl.ICommonsCollection<DefaultTreeItemWithID<KEYTYPE,VALUETYPE>> getAllItems()

Specified by:

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

Returns:

A non-null collection of all items.

isItemSameOrDescendant

default 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

default 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
default 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
default com.helger.commons.collection.impl.ICommonsCollection<VALUETYPE> getAllItemDatas()

Specified by:

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

Returns:

A non-null collection of all item datas.

removeItemWithID

@Nonnull
default com.helger.commons.state.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.