com.helger.commons.tree.sort

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

java.lang.Object

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

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

com.helger.commons.tree.sort.ComparatorTreeItemData<DATATYPE,ITEMTYPE>

Type Parameters:

DATATYPE - tree item value type

ITEMTYPE - tree item implementation type

All Implemented Interfaces:

ISerializableComparator<ITEMTYPE>, Serializable, Comparator<ITEMTYPE>

Direct Known Subclasses:

ComparatorDefaultTreeItem, ComparatorDefaultTreeItemWithIDData

@NotThreadSafe
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.

Method Summary

Modifier and Type	Method and Description
protected DATATYPE	getPart(ITEMTYPE aTreeItem) Implement this method to extract the part to compare from the original object.

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

getPartComparator, mainCompare, toString

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

compare, getNestedComparator, getSortOrder, isNullValuesComeFirst, setNestedComparator, setNullValuesComeFirst, setSortOrder

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Comparator

comparing, comparing, comparingDouble, comparingInt, comparingLong, equals, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

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.

Method Detail

getPart

@Nullable
protected DATATYPE getPart(@Nonnull
                                      ITEMTYPE aTreeItem)

Description copied from class: AbstractPartComparator

Implement this method to extract the part to compare from the original object.

Specified by:

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

Parameters:

aTreeItem - The object to be compared. Never null.

Returns:

The part of the source object to be compared with the part comparator provided in the constructor. May be null.