com.helger.commons.compare

Class CollatingComparatorToString

java.lang.Object

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

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

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

com.helger.commons.compare.CollatingComparatorToString

All Implemented Interfaces:

ISerializableComparator<Object>, Serializable, Comparator<Object>

@NotThreadSafe
public class CollatingComparatorToString
extends AbstractCollatingComparator<Object>

A simple collation aware comparator that compares objects by their "toString" representation.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected String	getPart(Object aValue) 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

CollatingComparatorToString

public CollatingComparatorToString(@Nullable
                                   Locale aSortLocale)

Comparator with default sort order and specified sort locale.

Parameters:

aSortLocale - The locale to use. May be null.

CollatingComparatorToString

public CollatingComparatorToString(@Nonnull
                                   Collator aCollator)

Constructor with Collator using the default sort order

Parameters:

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

Method Detail

getPart

protected String getPart(@Nullable
                         Object aValue)

Description copied from class: AbstractPartComparator

Implement this method to extract the part to compare from the original object.

Specified by:

getPart in class AbstractPartComparator<Object,String>

Parameters:

aValue - 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.