com.phloc.commons.compare

Class AbstractNumericComparator<DATATYPE>

java.lang.Object

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

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

Type Parameters:

DATATYPE - The data type to be compared. Must somehow have a value that can be compared as a double value.

All Implemented Interfaces:

Serializable, Comparator<DATATYPE>

public abstract class AbstractNumericComparator<DATATYPE>
extends AbstractComparator<DATATYPE>

Abstract comparator that handles values that can be represented as double values.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractNumericComparator()
AbstractNumericComparator(Comparator<? super DATATYPE> aNestedComparator) Comparator with default sort order and a nested comparator.
AbstractNumericComparator(ESortOrder eSortOrder) Compare with a special order.
AbstractNumericComparator(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 double	asDouble(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

AbstractNumericComparator

public AbstractNumericComparator()

AbstractNumericComparator

public AbstractNumericComparator(@Nonnull
                         ESortOrder eSortOrder)

Compare with a special order.

Parameters:

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

AbstractNumericComparator

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

AbstractNumericComparator

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

asDouble

protected abstract double asDouble(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.