com.phloc.commons.compare

Class AbstractPartComparatorComparable<DATATYPE,PARTTYPE extends Comparable<? super PARTTYPE>>

java.lang.Object

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

com.phloc.commons.compare.AbstractPartComparatorComparable<DATATYPE,PARTTYPE>

Type Parameters:

DATATYPE - The data type to be compared

PARTTYPE - The part type that is extracted from the data element and compared

All Implemented Interfaces:

Serializable, Comparator<DATATYPE>

Direct Known Subclasses:

ComparatorChangeLogComponent, ComparatorHasIDComparable, ComparatorPairFirst, ComparatorPairSecond, ComparatorTreeItemDataComparable

public abstract class AbstractPartComparatorComparable<DATATYPE,PARTTYPE extends Comparable<? super PARTTYPE>>
extends AbstractComparator<DATATYPE>

This class is an AbstractComparator that extracts a certain data element from the main object to compare.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract PARTTYPE	getPart(DATATYPE aObject)
protected int	mainCompare(DATATYPE aElement1, DATATYPE aElement2)

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

AbstractPartComparatorComparable

public AbstractPartComparatorComparable()

Comparator with default sort order.

AbstractPartComparatorComparable

public AbstractPartComparatorComparable(@Nonnull
                                ESortOrder eSortOrder)

Constructor with sort order.

Parameters:

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

AbstractPartComparatorComparable

public AbstractPartComparatorComparable(@Nullable
                                Comparator<? super DATATYPE> aNestedComparator)

Comparator with default sort order and a nested comparator.

Parameters:

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

AbstractPartComparatorComparable

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

Comparator 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.

Method Detail

getPart

@Nullable
protected abstract PARTTYPE getPart(DATATYPE aObject)

mainCompare

protected final int mainCompare(DATATYPE aElement1,
              DATATYPE aElement2)

Specified by:

mainCompare in class AbstractComparator<DATATYPE>

Parameters:

aElement1 - First element to compare. No information on the null status.

aElement2 - Second element to compare. No information on the null status.

Returns:

a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.