com.phloc.commons.tree.utils.sort

Class ComparatorTreeItemData<DATATYPE,ITEMTYPE extends IBasicTreeItem<DATATYPE,ITEMTYPE>>

java.lang.Object

com.phloc.commons.compare.AbstractComparator<DATATYPE>

com.phloc.commons.compare.AbstractPartComparator<ITEMTYPE,DATATYPE>

com.phloc.commons.tree.utils.sort.ComparatorTreeItemData<DATATYPE,ITEMTYPE>

Type Parameters:

DATATYPE - tree item value type

ITEMTYPE - tree item implementation type

All Implemented Interfaces:

Serializable, Comparator<ITEMTYPE>

Direct Known Subclasses:

ComparatorDefaultTreeItem, ComparatorDefaultTreeItemWithIDData

public class ComparatorTreeItemData<DATATYPE,ITEMTYPE extends IBasicTreeItem<DATATYPE,ITEMTYPE>>
extends AbstractPartComparator<ITEMTYPE,DATATYPE>

Comparator for sorting IBasicTreeItem items by their data using an explicit Comparator.
Works for ITreeItem and ITreeItemWithID.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ComparatorTreeItemData(Comparator<? super DATATYPE> aDataComparator) Constructor with default sort order.
ComparatorTreeItemData(Comparator<? super ITEMTYPE> aNestedComparator, Comparator<? super DATATYPE> aDataComparator) Comparator with default sort order and a nested comparator.
ComparatorTreeItemData(ESortOrder eSortOrder, Comparator<? super DATATYPE> aDataComparator) Constructor with sort order.
ComparatorTreeItemData(ESortOrder eSortOrder, Comparator<? super ITEMTYPE> aNestedComparator, Comparator<? super DATATYPE> aDataComparator) Constructor with sort order and a nested comparator.

Method Summary

Methods

Modifier and Type	Method and Description
protected DATATYPE	getPart(ITEMTYPE aTreeItem)

Methods inherited from class com.phloc.commons.compare.AbstractPartComparator

mainCompare

Methods inherited from class com.phloc.commons.compare.AbstractComparator

compare, getSortOrder, setSortOrder

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Comparator

equals

Constructor Detail

ComparatorTreeItemData

public ComparatorTreeItemData(@Nonnull
                      Comparator<? super DATATYPE> aDataComparator)

Constructor with default sort order.

Parameters:

aDataComparator - Comparator for the data elements. May not be null.

ComparatorTreeItemData

public ComparatorTreeItemData(@Nonnull
                      ESortOrder eSortOrder,
                      @Nonnull
                      Comparator<? super DATATYPE> aDataComparator)

Constructor with sort order.

Parameters:

aDataComparator - Comparator for the data elements. May not be null.

eSortOrder - The sort order to use. May not be null.

ComparatorTreeItemData

public ComparatorTreeItemData(@Nullable
                      Comparator<? super ITEMTYPE> aNestedComparator,
                      @Nonnull
                      Comparator<? super DATATYPE> aDataComparator)

Comparator with default sort order and a nested comparator.

Parameters:

aNestedComparator - The nested comparator to be invoked, when the main comparison resulted in 0.

aDataComparator - The comparator for comparing the IDs. May not be null.

ComparatorTreeItemData

public ComparatorTreeItemData(@Nonnull
                      ESortOrder eSortOrder,
                      @Nullable
                      Comparator<? super ITEMTYPE> aNestedComparator,
                      @Nonnull
                      Comparator<? super DATATYPE> aDataComparator)

Constructor with sort order and a nested comparator.

Parameters:

eSortOrder - The sort order to use. May not be null.

aNestedComparator - The nested comparator to be invoked, when the main comparison resulted in 0.

aDataComparator - The comparator for comparing the IDs. May not be null.

Method Detail

getPart

@Nullable
protected DATATYPE getPart(@Nonnull
                        ITEMTYPE aTreeItem)

Specified by:

getPart in class AbstractPartComparator<ITEMTYPE extends IBasicTreeItem<DATATYPE,ITEMTYPE>,DATATYPE>