com.helger.commons.compare

Class CollatingComparator

java.lang.Object

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

com.helger.commons.compare.CollatingComparator

All Implemented Interfaces:

ISerializableComparator<String>, Serializable, Comparator<String>

@NotThreadSafe
public class CollatingComparator
extends AbstractComparator<String>

An implementation of a Comparator that compares String objects with a Collator.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Collator	getCollator()
protected int	mainCompare(String sElement1, String sElement2)
String	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

CollatingComparator

public CollatingComparator(@Nullable
                           Locale aSortLocale)

Comparator with default sort order and specified sort locale.

Parameters:

aSortLocale - The locale to use. May be null.

CollatingComparator

public CollatingComparator(@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.

mainCompare

protected final int mainCompare(@Nonnull
                                String sElement1,
                                @Nonnull
                                String sElement2)

Specified by:

mainCompare in class AbstractComparator<String>

Parameters:

sElement1 - First element to compare. Never null.

sElement2 - Second element to compare. Never null.

Returns:

a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

toString

public String toString()

Overrides:

toString in class AbstractComparator<String>