com.helger.commons.tree

Interface ITreeItemFactory<DATATYPE,ITEMTYPE extends ITreeItem<DATATYPE,ITEMTYPE>>

Type Parameters:

DATATYPE - item value type

ITEMTYPE - item implementation type

All Superinterfaces:

IHierarchicalFactory<ITEMTYPE>, IHierarchicalRootFactory<ITEMTYPE>

All Known Implementing Classes:

AbstractTreeItemFactory, DefaultTreeItemFactory

public interface ITreeItemFactory<DATATYPE,ITEMTYPE extends ITreeItem<DATATYPE,ITEMTYPE>>
extends IHierarchicalFactory<ITEMTYPE>, IHierarchicalRootFactory<ITEMTYPE>

Interface for a simple tree item factory

Author:

Philip Helger

Method Summary

Modifier and Type	Method and Description
ITEMTYPE	create(ITEMTYPE aParent) Create an object of the desired type.
ITEMTYPE	createRoot() Create the root object.

Method Detail

createRoot

@Nonnull
ITEMTYPE createRoot()

Create the root object. May be called only once.

Specified by:

createRoot in interface IHierarchicalRootFactory<ITEMTYPE extends ITreeItem<DATATYPE,ITEMTYPE>>

Returns:

The root object. May be null depending on the implementation.

create

@Nonnull
ITEMTYPE create(@Nonnull
                          ITEMTYPE aParent)

Create an object of the desired type.

Specified by:

create in interface IHierarchicalFactory<ITEMTYPE extends ITreeItem<DATATYPE,ITEMTYPE>>

Parameters:

aParent - The parent item to use. May never be null.

Returns:

The created object.