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 type of elements 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:

ComparatorHasID, ComparatorTreeItemData

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 DATATYPE> aNestedComparator, Comparator<? super PARTTYPE> aPartComparator) Comparator with default sort order and a nested comparator.
AbstractPartComparator(Comparator<? super PARTTYPE> aPartComparator) Comparator with default sort order and no nested comparator.
AbstractPartComparator(ESortOrder eSortOrder, Comparator<? super DATATYPE> aNestedComparator, Comparator<? super PARTTYPE> aPartComparator) Constructor with sort order and a nested comparator.
AbstractPartComparator(ESortOrder eSortOrder, Comparator<? super PARTTYPE> aPartComparator) Constructor with sort order and no nested comparator.

Method Summary

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

Methods inherited from class com.helger.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

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 no nested comparator.

Parameters:

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

AbstractPartComparator

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

Constructor with sort order and no nested comparator.

Parameters:

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

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

AbstractPartComparator

public AbstractPartComparator(@Nullable
                              Comparator<? super DATATYPE> aNestedComparator,
                              @Nonnull
                              Comparator<? super PARTTYPE> aPartComparator)

Comparator with default sort order and a nested comparator.

Parameters:

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

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

AbstractPartComparator

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

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.

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

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.