com.phloc.commons.name

Class ComparatorHasDisplayName<DATATYPE extends IHasDisplayName>

java.lang.Object

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

com.phloc.commons.compare.AbstractCollationComparator<DATATYPE>

com.phloc.commons.name.ComparatorHasDisplayName<DATATYPE>

Type Parameters:

DATATYPE - The type of elements to be compared.

All Implemented Interfaces:

Serializable, Comparator<DATATYPE>

public final class ComparatorHasDisplayName<DATATYPE extends IHasDisplayName>
extends AbstractCollationComparator<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
ComparatorHasDisplayName(Locale aSortLocale) Comparator with default sort order but special collation locale.
ComparatorHasDisplayName(Locale aSortLocale, ESortOrder eSortOrder) Comparator with special sort order and a special collation locale.

Method Summary

Methods

Modifier and Type	Method and Description
protected String	asString(DATATYPE aObject) Abstract method that needs to be overridden to convert an object to a string representation for comparison.

Methods inherited from class com.phloc.commons.compare.AbstractCollationComparator

mainCompare, toString

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

compare, getSortOrder, 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

equals

Constructor Detail

ComparatorHasDisplayName

public ComparatorHasDisplayName(@Nullable
                        Locale aSortLocale)

Comparator with default sort order but special collation locale.

Parameters:

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

ComparatorHasDisplayName

public ComparatorHasDisplayName(@Nullable
                        Locale aSortLocale,
                        @Nonnull
                        ESortOrder eSortOrder)

Comparator with special sort order and a special collation locale.

Parameters:

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

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

Method Detail

asString

protected String asString(DATATYPE aObject)

Description copied from class: AbstractCollationComparator

Abstract method that needs to be overridden to convert an object to a string representation for comparison.

Specified by:

asString in class AbstractCollationComparator<DATATYPE extends IHasDisplayName>

Parameters:

aObject - The object to be converted. May not be null depending on the elements to be sorted.

Returns:

The string representation of the object. May be null.