com.phloc.commons.compare

Class ComparatorComparable<DATATYPE extends Comparable<? super DATATYPE>>

java.lang.Object

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

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

All Implemented Interfaces:

Serializable, Comparator<DATATYPE>

public class ComparatorComparable<DATATYPE extends Comparable<? super DATATYPE>>
extends AbstractComparator<DATATYPE>

This is another *lol* class: a Comparator for Comparable objects.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
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

ComparatorComparable

public ComparatorComparable()

Comparator with default sort order and no nested comparator.

ComparatorComparable

public ComparatorComparable(@Nonnull
                    ESortOrder eSortOrder)

Constructor with sort order.

Parameters:

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

ComparatorComparable

public ComparatorComparable(@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.

ComparatorComparable

public ComparatorComparable(@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

mainCompare

protected final int mainCompare(@Nonnull
              DATATYPE aElement1,
              @Nonnull
              DATATYPE aElement2)

Specified by:

mainCompare in class AbstractComparator<DATATYPE extends Comparable<? super 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.