com.helger.commons.compare

Class AbstractCollatingComparator<DATATYPE>

java.lang.Object

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

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

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

Type Parameters:

DATATYPE - the type of object to be compared

All Implemented Interfaces:

ISerializableComparator<DATATYPE>, Serializable, Comparator<DATATYPE>

Direct Known Subclasses:

CollatingComparatorDisplayNameProvider, CollatingComparatorDisplayTextProvider, CollatingComparatorFileName, CollatingComparatorHasDisplayName, CollatingComparatorHasDisplayText, CollatingComparatorHasName, CollatingComparatorLocaleCountry, CollatingComparatorLocaleDisplayCountry, CollatingComparatorLocaleDisplayCountryInLocale, CollatingComparatorLocaleDisplayCountryNative, CollatingComparatorLocaleDisplayLanguage, CollatingComparatorLocaleDisplayLanguageInLocale, CollatingComparatorLocaleDisplayLanguageNative, CollatingComparatorLocaleDisplayName, CollatingComparatorLocaleDisplayNameInLocale, CollatingComparatorLocaleDisplayNameNative, CollatingComparatorLocaleLanguage, CollatingComparatorToString

@NotThreadSafe
public abstract class AbstractCollatingComparator<DATATYPE>
extends AbstractPartComparator<DATATYPE,String>

An abstract implementation of a Comparator that uses collations for ordering. This is only necessary when comparing strings.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractCollatingComparator(Collator aCollator) Constructor with Collator using the default sort order
AbstractCollatingComparator(Locale aSortLocale) Comparator with default sort order and specified sort locale.

Method Summary

Methods

Modifier and Type	Method and Description
Collator	getCollator()

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

getPart, 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

equals

Constructor Detail

AbstractCollatingComparator

public AbstractCollatingComparator(@Nullable
                           Locale aSortLocale)

Comparator with default sort order and specified sort locale.

Parameters:

aSortLocale - The locale to use. May be null.

AbstractCollatingComparator

public AbstractCollatingComparator(@Nonnull
                           Collator aCollator)

Constructor with Collator using the default sort order

Parameters:

aCollator - The Collator to use. May not be null.

Method Detail

getCollator

@Nonnull
@ReturnsMutableCopy
public final Collator getCollator()

Returns:

A copy of the Collator as passed or created in the constructor. Never null.