com.phloc.commons.tree.utils.sort

Class ComparatorTreeItemID<KEYTYPE,DATATYPE,ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>>

java.lang.Object

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

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

com.phloc.commons.id.ComparatorHasID<KEYTYPE,ITEMTYPE>

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

Type Parameters:

KEYTYPE - tree item key type

DATATYPE - tree item value type

ITEMTYPE - tree item implementation type

All Implemented Interfaces:

Serializable, Comparator<ITEMTYPE>

public class ComparatorTreeItemID<KEYTYPE,DATATYPE,ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>>
extends ComparatorHasID<KEYTYPE,ITEMTYPE>

Comparator for sorting ITreeItemWithID items by their ID using an explicit Comparator.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ComparatorTreeItemID(Comparator<? super ITEMTYPE> aNestedComparator, Comparator<? super KEYTYPE> aIDComparator) Comparator with default sort order and a nested comparator.
ComparatorTreeItemID(Comparator<? super KEYTYPE> aIDComparator) Comparator with default sort order and no nested comparator.
ComparatorTreeItemID(ESortOrder eSortOrder, Comparator<? super ITEMTYPE> aNestedComparator, Comparator<? super KEYTYPE> aIDComparator) Constructor with sort order and a nested comparator.
ComparatorTreeItemID(ESortOrder eSortOrder, Comparator<? super KEYTYPE> aIDComparator) Constructor with sort order and no nested comparator.

Method Summary

Methods inherited from class com.phloc.commons.id.ComparatorHasID

getPart

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

ComparatorTreeItemID

public ComparatorTreeItemID(@Nonnull
                    Comparator<? super KEYTYPE> aIDComparator)

Comparator with default sort order and no nested comparator.

Parameters:

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

ComparatorTreeItemID

public ComparatorTreeItemID(@Nonnull
                    ESortOrder eSortOrder,
                    @Nonnull
                    Comparator<? super KEYTYPE> aIDComparator)

Constructor with sort order and no nested comparator.

Parameters:

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

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

ComparatorTreeItemID

public ComparatorTreeItemID(@Nullable
                    Comparator<? super ITEMTYPE> aNestedComparator,
                    @Nonnull
                    Comparator<? super KEYTYPE> aIDComparator)

Comparator with default sort order and a nested comparator.

Parameters:

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

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

ComparatorTreeItemID

public ComparatorTreeItemID(@Nonnull
                    ESortOrder eSortOrder,
                    @Nullable
                    Comparator<? super ITEMTYPE> aNestedComparator,
                    @Nonnull
                    Comparator<? super KEYTYPE> aIDComparator)

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.

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