com.phloc.commons.name

Class ComparatorDisplayNameProvider<DATATYPE>

java.lang.Object

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

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

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

Type Parameters:

DATATYPE - The type of elements to be compared.

All Implemented Interfaces:

Serializable, Comparator<DATATYPE>

public final class ComparatorDisplayNameProvider<DATATYPE>
extends AbstractCollationComparator<DATATYPE>

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

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ComparatorDisplayNameProvider(Locale aSortLocale, IDisplayNameProvider<DATATYPE> aDisplayNameProvider) Constructor.
ComparatorDisplayNameProvider(Locale aSortLocale, IDisplayNameProvider<DATATYPE> aDisplayNameProvider, ESortOrder eSortOrder) Constructor.

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.
IDisplayNameProvider<DATATYPE>	getDisplayNameProvider()

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

ComparatorDisplayNameProvider

public ComparatorDisplayNameProvider(@Nullable
                             Locale aSortLocale,
                             @Nonnull
                             IDisplayNameProvider<DATATYPE> aDisplayNameProvider)

Constructor.

Parameters:

aSortLocale - The locale to be used for sorting. May be null.

aDisplayNameProvider - The display text provider to be used. May not be null.

ComparatorDisplayNameProvider

public ComparatorDisplayNameProvider(@Nullable
                             Locale aSortLocale,
                             @Nonnull
                             IDisplayNameProvider<DATATYPE> aDisplayNameProvider,
                             @Nonnull
                             ESortOrder eSortOrder)

Constructor.

Parameters:

aSortLocale - The locale to be used for sorting. May be null.

aDisplayNameProvider - The display text provider to be used. May not be null.

eSortOrder - The sort order to be used. May not be null.

Method Detail

getDisplayNameProvider

@Nonnull
public IDisplayNameProvider<DATATYPE> getDisplayNameProvider()

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>

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.