com.helger.commons.name

Class CollatingComparatorHasDisplayName<DATATYPE extends IHasDisplayName>

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.CollatingComparatorHasDisplayName<DATATYPE>

Type Parameters:

DATATYPE - The type of elements to be compared.

All Implemented Interfaces:

ISerializableComparator<DATATYPE>, Serializable, Comparator<DATATYPE>

@NotThreadSafe
public class CollatingComparatorHasDisplayName<DATATYPE extends IHasDisplayName>
extends AbstractCollatingComparator<DATATYPE>

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

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CollatingComparatorHasDisplayName(Locale aSortLocale) Comparator with default sort order but special collation locale.

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

CollatingComparatorHasDisplayName

public CollatingComparatorHasDisplayName(@Nullable
                                         Locale aSortLocale)

Comparator with default sort order but special collation locale.

Parameters:

aSortLocale - The collation locale to use. May be null.

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 IHasDisplayName,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.