com.helger.tree.withid

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

java.lang.Object

com.helger.tree.withid.BasicTreeWithID<KEYTYPE,DATATYPE,ITEMTYPE>

Type Parameters:

KEYTYPE - tree item key type

DATATYPE - tree item value type

ITEMTYPE - tree item implementation type

All Implemented Interfaces:

com.helger.commons.hierarchy.IHasChildren<ITEMTYPE>, IBasicTree<DATATYPE,ITEMTYPE>, ITreeWithID<KEYTYPE,DATATYPE,ITEMTYPE>

Direct Known Subclasses:

BasicTreeWithGlobalUniqueID, DefaultTreeWithID

@NotThreadSafe
public class BasicTreeWithID<KEYTYPE,DATATYPE,ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>>
extends Object
implements ITreeWithID<KEYTYPE,DATATYPE,ITEMTYPE>

Base class for a tree having items with IDs. This implementation is independent of the item implementation class. The elements of the tree are not sorted by any means.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
BasicTreeWithID(ITreeItemWithIDFactory<KEYTYPE,DATATYPE,ITEMTYPE> aFactory)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
void	forAllChildren(Consumer<? super ITEMTYPE> aConsumer)
void	forAllChildren(Predicate<? super ITEMTYPE> aFilter, Consumer<? super ITEMTYPE> aConsumer)
com.helger.commons.state.EContinue	forAllChildrenBreakable(Function<? super ITEMTYPE,com.helger.commons.state.EContinue> aConsumer)
<DSTTYPE> void	forAllChildrenMapped(Predicate<? super ITEMTYPE> aFilter, Function<? super ITEMTYPE,? extends DSTTYPE> aMapper, Consumer<? super DSTTYPE> aConsumer)
com.helger.commons.collection.impl.ICommonsCollection<ITEMTYPE>	getAllChildren()
int	getChildCount()
com.helger.commons.collection.impl.ICommonsIterable<ITEMTYPE>	getChildren()
ITEMTYPE	getRootItem()
boolean	hasChildren()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

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

hasNoChildren

Constructor Detail

BasicTreeWithID

public BasicTreeWithID(@Nonnull
                       ITreeItemWithIDFactory<KEYTYPE,DATATYPE,ITEMTYPE> aFactory)

Method Detail

hasChildren

public final boolean hasChildren()

Specified by:

hasChildren in interface com.helger.commons.hierarchy.IHasChildren<ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>>

getChildCount

@Nonnegative
public final int getChildCount()

Specified by:

getChildCount in interface com.helger.commons.hierarchy.IHasChildren<ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>>

getAllChildren

@Nonnull
 @ReturnsMutableCopy
public final com.helger.commons.collection.impl.ICommonsCollection<ITEMTYPE> getAllChildren()

Specified by:

getAllChildren in interface com.helger.commons.hierarchy.IHasChildren<ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>>

getChildren

@Nonnull
public final com.helger.commons.collection.impl.ICommonsIterable<ITEMTYPE> getChildren()

Specified by:

getChildren in interface com.helger.commons.hierarchy.IHasChildren<ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>>

forAllChildren

public final void forAllChildren(@Nonnull
                                 Consumer<? super ITEMTYPE> aConsumer)

Specified by:

forAllChildren in interface com.helger.commons.hierarchy.IHasChildren<ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>>

forAllChildrenBreakable

@Nonnull
public final com.helger.commons.state.EContinue forAllChildrenBreakable(@Nonnull
                                                                                  Function<? super ITEMTYPE,com.helger.commons.state.EContinue> aConsumer)

Specified by:

forAllChildrenBreakable in interface com.helger.commons.hierarchy.IHasChildren<ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>>

forAllChildren

public final void forAllChildren(@Nonnull
                                 Predicate<? super ITEMTYPE> aFilter,
                                 @Nonnull
                                 Consumer<? super ITEMTYPE> aConsumer)

Specified by:

forAllChildren in interface com.helger.commons.hierarchy.IHasChildren<ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>>

forAllChildrenMapped

public final <DSTTYPE> void forAllChildrenMapped(@Nonnull
                                                 Predicate<? super ITEMTYPE> aFilter,
                                                 @Nonnull
                                                 Function<? super ITEMTYPE,? extends DSTTYPE> aMapper,
                                                 @Nonnull
                                                 Consumer<? super DSTTYPE> aConsumer)

Specified by:

forAllChildrenMapped in interface com.helger.commons.hierarchy.IHasChildren<ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>>

getRootItem

@Nonnull
public final ITEMTYPE getRootItem()

Specified by:

getRootItem in interface IBasicTree<DATATYPE,ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>>

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.

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