com.helger.commons.hierarchy

Class ChildrenProviderHasChildrenSorting<CHILDTYPE extends IHasChildren<CHILDTYPE>>

java.lang.Object

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

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

Type Parameters:

CHILDTYPE - The data type of the child objects.

All Implemented Interfaces:

IChildrenProvider<CHILDTYPE>

@Immutable
public class ChildrenProviderHasChildrenSorting<CHILDTYPE extends IHasChildren<CHILDTYPE>>
extends ChildrenProviderHasChildren<CHILDTYPE>

An implementation of the IChildrenProvider interface that works with all types that implement IHasChildren. It automatically sorts the returned children by the specified comparator.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
ChildrenProviderHasChildrenSorting(Comparator<? super CHILDTYPE> aComparator)

Method Summary

Modifier and Type	Method and Description
ICommonsList<? extends CHILDTYPE>	getAllChildren(CHILDTYPE aCurrent) Get the children of the passed object.
Comparator<? super CHILDTYPE>	getComparator()

Methods inherited from class com.helger.commons.hierarchy.ChildrenProviderHasChildren

getChildCount, hasChildren

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

ChildrenProviderHasChildrenSorting

public ChildrenProviderHasChildrenSorting(@Nonnull
                                          Comparator<? super CHILDTYPE> aComparator)

Method Detail

getComparator

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

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 extends IHasChildren<CHILDTYPE>>

Overrides:

getAllChildren in class ChildrenProviderHasChildren<CHILDTYPE extends IHasChildren<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.