com.helger.commons.hierarchy

Class ChildrenProviderHasChildrenSorted<CHILDTYPE extends IHasChildrenSorted<CHILDTYPE>>

java.lang.Object

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

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

Type Parameters:

CHILDTYPE - The data type of the child objects.

All Implemented Interfaces:

IChildrenProvider<CHILDTYPE>, IChildrenProviderSorted<CHILDTYPE>

@Immutable
public final class ChildrenProviderHasChildrenSorted<CHILDTYPE extends IHasChildrenSorted<CHILDTYPE>>
extends ChildrenProviderHasChildren<CHILDTYPE>
implements IChildrenProviderSorted<CHILDTYPE>

An IChildrenProviderSorted implementation for object implementing the IHasChildrenSorted interface.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
ChildrenProviderHasChildrenSorted()

Method Summary

Modifier and Type	Method and Description
ICommonsList<? extends CHILDTYPE>	getAllChildren(CHILDTYPE aCurrent) Get the children of the passed object.
CHILDTYPE	getChildAtIndex(CHILDTYPE aCurrent, int nIndex) Get the child of the passed object at the given index.

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

getChildCount, hasChildren, hasNoChildren

Constructor Detail

ChildrenProviderHasChildrenSorted

public ChildrenProviderHasChildrenSorted()

Method Detail

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 IHasChildrenSorted<CHILDTYPE>>

Specified by:

getAllChildren in interface IChildrenProviderSorted<CHILDTYPE extends IHasChildrenSorted<CHILDTYPE>>

Overrides:

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

getChildAtIndex

@Nullable
public CHILDTYPE getChildAtIndex(@Nullable
                                            CHILDTYPE aCurrent,
                                            @Nonnegative
                                            int nIndex)

Description copied from interface: IChildrenProviderSorted

Get the child of the passed object at the given index. It is assumed that objects are accessed in exactly the same order as they are delivered by IChildrenProviderSorted.getAllChildren(Object).

Specified by:

getChildAtIndex in interface IChildrenProviderSorted<CHILDTYPE extends IHasChildrenSorted<CHILDTYPE>>

Parameters:

aCurrent - The object to get the child of. May be null depending on the concrete implementation.

nIndex - The index to retrieve the child at.

Returns:

The child at the specified index. May not be < 0.