com.helger.commons.compare

Class AbstractPartComparator<DATATYPE,PARTTYPE>

java.lang.Object

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

com.helger.commons.compare.AbstractPartComparator<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:

ISerializableComparator<DATATYPE>, Serializable, Comparator<DATATYPE>

Direct Known Subclasses:

AbstractCollatingComparator, ComparatorHasID, ComparatorMapEntryKey, ComparatorMapEntryValue, ComparatorTreeItemData, ConverterComparator

@NotThreadSafe
public abstract class AbstractPartComparator<DATATYPE,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
AbstractPartComparator(Comparator<? super PARTTYPE> aPartComparator) Comparator with default sort order and a part comparator.

Method Summary

Modifier and Type	Method and Description
protected abstract PARTTYPE	getPart(DATATYPE aObject) Implement this method to extract the part to compare from the original object.
Comparator<? super PARTTYPE>	getPartComparator()
protected int	mainCompare(DATATYPE aElement1, DATATYPE aElement2)
String	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

AbstractPartComparator

public AbstractPartComparator(@Nonnull
                              Comparator<? super PARTTYPE> aPartComparator)

Comparator with default sort order and a part comparator.

Parameters:

aPartComparator - The comparator for comparing the extracted parts. May not be null.

Method Detail

getPartComparator

@Nonnull
public final Comparator<? super PARTTYPE> getPartComparator()

Returns:

The part comparator specified in the constructor. May be null.

getPart

@Nullable
protected abstract PARTTYPE getPart(@Nonnull
                                               DATATYPE aObject)

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

Parameters:

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

mainCompare

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

Specified by:

mainCompare in class AbstractComparator<DATATYPE>

Parameters:

aElement1 - First element to compare. Never null.

aElement2 - Second element to compare. Never null.

Returns:

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

toString

public String toString()

Overrides:

toString in class AbstractComparator<DATATYPE>