com.helger.commons.compare

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

java.lang.Object

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

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

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

@NotThreadSafe
public class ConverterComparatorComparable<DATATYPE,PARTTYPE extends Comparable<? super PARTTYPE>>
extends AbstractPartComparatorComparable<DATATYPE,PARTTYPE>

This is a Comparator for objects which are extracted from a converter.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ConverterComparatorComparable(IConverter<DATATYPE,PARTTYPE> aConverter) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
IConverter<DATATYPE,PARTTYPE>	getConverter()
protected PARTTYPE	getPart(DATATYPE aObject) Implement this method to extract the part to compare from the original object.

Methods inherited from class com.helger.commons.compare.AbstractPartComparatorComparable

mainCompare

Methods inherited from class com.helger.commons.compare.AbstractComparator

compare, getNestedComparator, getSortOrder, isNullValuesComeFirst, setNestedComparator, setNullValuesComeFirst, setSortOrder, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Comparator

equals

Constructor Detail

ConverterComparatorComparable

public ConverterComparatorComparable(@Nonnull
                             IConverter<DATATYPE,PARTTYPE> aConverter)

Constructor.

Parameters:

aConverter - The converter to be used to extract the part from the source object. May not be null.

Method Detail

getConverter

@Nonnull
public final IConverter<DATATYPE,PARTTYPE> getConverter()

Returns:

The converter passed in the constructor. Never null.

getPart

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

Description copied from class: AbstractPartComparatorComparable

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

Specified by:

getPart in class AbstractPartComparatorComparable<DATATYPE,PARTTYPE extends Comparable<? super PARTTYPE>>

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.