com.phloc.commons.parent

Interface IHasChildrenSorted<CHILDTYPE>

Type Parameters:

CHILDTYPE - The type of the children.

All Superinterfaces:

IHasChildren<CHILDTYPE>

All Known Subinterfaces:

IBasicTreeItem<DATATYPE,ITEMTYPE>, IFolderTreeItem<KEYTYPE,DATATYPE,COLLTYPE,ITEMTYPE>, IMicroCDATA, IMicroComment, IMicroContainer, IMicroDocument, IMicroDocumentType, IMicroElement, IMicroEntityReference, IMicroNode, IMicroNodeWithChildren, IMicroProcessingInstruction, IMicroText, ITreeItem<DATATYPE,ITEMTYPE>, ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>

All Known Implementing Classes:

AbstractMicroNode, AbstractMicroNodeWithChildren, BasicFolderTreeItem, BasicTreeItem, BasicTreeItemWithID, DefaultFolderTreeItem, DefaultTreeItem, DefaultTreeItemWithID, MicroCDATA, MicroComment, MicroContainer, MicroDocument, MicroDocumentType, MicroElement, MicroEntityReference, MicroProcessingInstruction, MicroText

public interface IHasChildrenSorted<CHILDTYPE>
extends IHasChildren<CHILDTYPE>

Extends IHasChildren by indicating that the child items are sorted!

Author:

Philip Helger

Method Summary

Methods

Modifier and Type	Method and Description
CHILDTYPE	getChildAtIndex(int nIndex) Get the child node at the specified index
List<? extends CHILDTYPE>	getChildren()
CHILDTYPE	getFirstChild() Get the first child node or null if no child is present
CHILDTYPE	getLastChild() Get the last child node or null if no child is present

Methods inherited from interface com.phloc.commons.parent.IHasChildren

getChildCount, hasChildren

Method Detail

getChildren

@Nullable
List<? extends CHILDTYPE> getChildren()

Specified by:

getChildren in interface IHasChildren<CHILDTYPE>

Returns:

A ordered list of child elements. May be null if no children are present.

getChildAtIndex

@Nullable
CHILDTYPE getChildAtIndex(@Nonnegative
                                 int nIndex)

Get the child node at the specified index

Parameters:

nIndex - The index to be queried. May not be < 0 or ≥ the number of children

Returns:

The child at the specified index or null if the index is invalid.

Throws:

IndexOutOfBoundsException - in case the index is invalid

getFirstChild

@Nullable
CHILDTYPE getFirstChild()

Get the first child node or null if no child is present

Returns:

The first child or null.

getLastChild

@Nullable
CHILDTYPE getLastChild()

Get the last child node or null if no child is present

Returns:

The last child or null.