com.helger.commons.collection.pair

Class ComparatorPairFirstComparable<DATA1TYPE extends Comparable<? super DATA1TYPE>,DATA2TYPE>

java.lang.Object

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

com.helger.commons.compare.AbstractPartComparatorComparable<IPair<DATA1TYPE,DATA2TYPE>,DATA1TYPE>

com.helger.commons.collection.pair.ComparatorPairFirstComparable<DATA1TYPE,DATA2TYPE>

Type Parameters:

DATA1TYPE - pair first type

DATA2TYPE - pair second type

All Implemented Interfaces:

ISerializableComparator<IPair<DATA1TYPE,DATA2TYPE>>, Serializable, Comparator<IPair<DATA1TYPE,DATA2TYPE>>

@NotThreadSafe
public class ComparatorPairFirstComparable<DATA1TYPE extends Comparable<? super DATA1TYPE>,DATA2TYPE>
extends AbstractPartComparatorComparable<IPair<DATA1TYPE,DATA2TYPE>,DATA1TYPE>

Comparator comparing IPair objects by the first element

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ComparatorPairFirstComparable()

Method Summary

Methods

Modifier and Type	Method and Description
protected DATA1TYPE	getPart(IPair<DATA1TYPE,DATA2TYPE> 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

ComparatorPairFirstComparable

public ComparatorPairFirstComparable()

Method Detail

getPart

@Nullable
protected DATA1TYPE getPart(@Nonnull
                         IPair<DATA1TYPE,DATA2TYPE> 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<IPair<DATA1TYPE extends Comparable<? super DATA1TYPE>,DATA2TYPE>,DATA1TYPE extends Comparable<? super DATA1TYPE>>

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.