com.helger.commons.name

Class ComparatorHasName<DATATYPE extends IHasName>

java.lang.Object

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

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

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

Type Parameters:

DATATYPE - The type of elements to be compared.

All Implemented Interfaces:

Serializable, Comparator<DATATYPE>

public final class ComparatorHasName<DATATYPE extends IHasName>
extends AbstractCollationComparator<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
ComparatorHasName(Locale aSortLocale)
ComparatorHasName(Locale aSortLocale, ESortOrder eSortOrder)

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.helger.commons.compare.AbstractCollationComparator

mainCompare, toString

Methods inherited from class com.helger.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

ComparatorHasName

public ComparatorHasName(@Nullable
                 Locale aSortLocale)

ComparatorHasName

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

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 IHasName>

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.