com.phloc.commons.tree.utils.build

Class TreeWithIDBuilder

java.lang.Object

com.phloc.commons.tree.utils.build.TreeWithIDBuilder

@Immutable
public final class TreeWithIDBuilder
extends Object

Utility classes for building a tree from flat collections.

Author:

Philip Helger

Method Summary

Methods

Modifier and Type	Method and Description
static <KEYTYPE,DATATYPE extends IHasParent<DATATYPE> & IHasID<KEYTYPE>> DefaultTreeWithID<KEYTYPE,DATATYPE>	buildTree(Collection<? extends DATATYPE> aAll) A generic method to build a tree of objects.
static <KEYTYPE,DATATYPE extends IHasID<KEYTYPE>> DefaultTreeWithID<KEYTYPE,DATATYPE>	buildTree(Collection<? extends DATATYPE> aAll, IParentProvider<DATATYPE> aParentResolver) A generic method to build a tree of objects.
static <KEYTYPE,DATATYPE extends IHasID<KEYTYPE>> DefaultTreeWithID<KEYTYPE,DATATYPE>	buildTree(DATATYPE[] aAll, IParentProvider<DATATYPE> aParentResolver) A generic method to build a tree of objects.
static <KEYTYPE,DATATYPE extends IHasID<KEYTYPE>> DefaultTreeWithID<KEYTYPE,DATATYPE>	buildTree(IChildrenProvider<DATATYPE> aChildrenResolver)

Methods inherited from class java.lang.Object

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

Method Detail

buildTree

@Nonnull
public static <KEYTYPE,DATATYPE extends IHasID<KEYTYPE>> DefaultTreeWithID<KEYTYPE,DATATYPE> buildTree(@Nonnull
                                                                                               Collection<? extends DATATYPE> aAll,
                                                                                               @Nonnull
                                                                                               IParentProvider<DATATYPE> aParentResolver)

A generic method to build a tree of objects.

Type Parameters:

KEYTYPE - The tree key type.

DATATYPE - The tree item value type.

Parameters:

aAll - A linear list of objects to build the tree from. May not be null.

aParentResolver - The callback method to determine the parental object of a given object. May not be null.

Returns:

A tree with all the objects. Never null.

Throws:

IllegalStateException - if the hierarchy cannot be determined because an object references a parent that is not in the list!

buildTree

@Nonnull
public static <KEYTYPE,DATATYPE extends IHasID<KEYTYPE>> DefaultTreeWithID<KEYTYPE,DATATYPE> buildTree(@Nonnull
                                                                                               DATATYPE[] aAll,
                                                                                               @Nonnull
                                                                                               IParentProvider<DATATYPE> aParentResolver)

A generic method to build a tree of objects.

Type Parameters:

KEYTYPE - The tree key type.

DATATYPE - The tree item value type.

Parameters:

aAll - A linear list of objects to build the tree from. May not be null.

aParentResolver - The callback method to determine the parental object of a given object. May not be null.

Returns:

A tree with all the objects. Never null.

Throws:

IllegalStateException - if the hierarchy cannot be determined because an object references a parent that is not in the list!

buildTree

@Nonnull
public static <KEYTYPE,DATATYPE extends IHasParent<DATATYPE> & IHasID<KEYTYPE>> DefaultTreeWithID<KEYTYPE,DATATYPE> buildTree(@Nonnull
                                                                                                                     Collection<? extends DATATYPE> aAll)

A generic method to build a tree of objects.

Type Parameters:

KEYTYPE - The tree key type.

DATATYPE - The tree item value type.

Parameters:

aAll - A linear list of objects to build the tree from. May not be null.

Returns:

A tree with all the objects. Never null.

Throws:

IllegalStateException - if the hierarchy cannot be determined because an object references a parent that is not in the list!

buildTree

@Nonnull
public static <KEYTYPE,DATATYPE extends IHasID<KEYTYPE>> DefaultTreeWithID<KEYTYPE,DATATYPE> buildTree(@Nonnull
                                                                                               IChildrenProvider<DATATYPE> aChildrenResolver)