com.helger.commons.name

Class CollatingComparatorHasName<DATATYPE extends IHasName>

java.lang.Object

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

com.helger.commons.compare.AbstractPartComparator<DATATYPE,String>

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

com.helger.commons.name.CollatingComparatorHasName<DATATYPE>

Type Parameters:

DATATYPE - The type of elements to be compared.

All Implemented Interfaces:

ISerializableComparator<DATATYPE>, Serializable, Comparator<DATATYPE>

@NotThreadSafe
public class CollatingComparatorHasName<DATATYPE extends IHasName>
extends AbstractCollatingComparator<DATATYPE>

This is a collation Comparator for objects that implement the IHasName interface.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CollatingComparatorHasName(Locale aSortLocale)

Method Summary

Modifier and Type	Method and Description
protected String	getPart(DATATYPE aObject) Implement this method to extract the part to compare from the original object.

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

getCollator

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

getPartComparator, mainCompare, 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

CollatingComparatorHasName

public CollatingComparatorHasName(@Nullable
                                  Locale aSortLocale)

Method Detail

getPart

protected String getPart(@Nonnull
                         DATATYPE aObject)

Description copied from class: AbstractPartComparator

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

Specified by:

getPart in class AbstractPartComparator<DATATYPE extends IHasName,String>

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.