Package com.helger.commons.hierarchy

Class ChildrenProviderSorting<CHILDTYPE>

java.lang.Object

com.helger.commons.hierarchy.ChildrenProviderSorting<CHILDTYPE>

Type Parameters:

CHILDTYPE - The data type of the child objects.

All Implemented Interfaces:

IChildrenProvider<CHILDTYPE>

Direct Known Subclasses:

ChildrenProviderSortingWithID

@Immutable
public class ChildrenProviderSorting<CHILDTYPE>
extends Object
implements IChildrenProvider<CHILDTYPE>

An IChildrenProvider that returns the children in getAllChildren(Object) sorted.
The implementation wraps an existing children provider and uses and external comparator for sorting.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor	Description
ChildrenProviderSorting(IChildrenProvider<CHILDTYPE> aCP, Comparator<? super CHILDTYPE> aComparator)	Constructor.

Method Summary

Modifier and Type	Method	Description
ICommonsList<? extends CHILDTYPE>	getAllChildren(CHILDTYPE aCurrent)	Get the children of the passed object.
int	getChildCount(CHILDTYPE aCurrent)
IChildrenProvider<CHILDTYPE>	getChildrenProvider()
Comparator<? super CHILDTYPE>	getComparator()
boolean	hasChildren(CHILDTYPE aCurrent)	Check if an item has children.

Methods inherited from class java.lang.Object

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

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

hasNoChildren

Constructor Detail

ChildrenProviderSorting

public ChildrenProviderSorting(@Nonnull
                               IChildrenProvider<CHILDTYPE> aCP,
                               @Nonnull
                               Comparator<? super CHILDTYPE> aComparator)

Constructor.

Parameters:

aCP - The children provider to be wrapped

aComparator - The comparator to be used for sorting children.

Method Detail

getChildrenProvider

@Nonnull
public IChildrenProvider<CHILDTYPE> getChildrenProvider()

getComparator

@Nonnull
public Comparator<? super CHILDTYPE> getComparator()

hasChildren

public final boolean hasChildren(@Nullable
                                 CHILDTYPE aCurrent)

Description copied from interface: IChildrenProvider

Check if an item has children.

Specified by:

hasChildren in interface IChildrenProvider<CHILDTYPE>

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

public final int getChildCount(@Nullable
                               CHILDTYPE aCurrent)

Specified by:

getChildCount in interface IChildrenProvider<CHILDTYPE>

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 ICommonsList<? extends CHILDTYPE> getAllChildren(@Nullable
                                                        CHILDTYPE aCurrent)

Description copied from interface: IChildrenProvider

Get the children of the passed object.

Specified by:

getAllChildren in interface IChildrenProvider<CHILDTYPE>

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.