com.phloc.commons.compare

Class ComparatorString

java.lang.Object

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

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

com.phloc.commons.compare.ComparatorString

All Implemented Interfaces:

Serializable, Comparator<String>

public class ComparatorString
extends AbstractCollationComparator<String>

A simple collation aware comparator that compares String objects.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ComparatorString() Comparator with default locale Collator and default sort order.
ComparatorString(Collator aCollator) Constructor with Collator using the default sort order
ComparatorString(Collator aCollator, Comparator<? super String> aNestedComparator) Constructor with Collator using the default sort order and a nested comparator.
ComparatorString(Collator aCollator, ESortOrder eSortOrder) Constructor with Collator and sort order.
ComparatorString(Collator aCollator, ESortOrder eSortOrder, Comparator<? super String> aNestedComparator) Constructor with Collator and sort order and a nested comparator.
ComparatorString(Comparator<? super String> aNestedComparator) Comparator with default locale Collator and default sort order and a nested comparator.
ComparatorString(ESortOrder eSortOrder) Comparator with default locale Collator.
ComparatorString(ESortOrder eSortOrder, Comparator<? super String> aNestedComparator) Comparator with default locale Collator and a nested comparator.
ComparatorString(Locale aSortLocale) Comparator with default sort order and specified sort locale.
ComparatorString(Locale aSortLocale, Comparator<? super String> aNestedComparator) Comparator with default sort order but special locale and a nested comparator.
ComparatorString(Locale aSortLocale, ESortOrder eSortOrder) Constructor with locale and sort order.
ComparatorString(Locale aSortLocale, ESortOrder eSortOrder, Comparator<? super String> aNestedComparator) Constructor with locale and sort order and a nested comparator.

Method Summary

Methods

Modifier and Type	Method and Description
protected String	asString(String sValue) Abstract method that needs to be overridden to convert an object to a string representation for comparison.

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

ComparatorString

public ComparatorString()

Comparator with default locale Collator and default sort order.

ComparatorString

public ComparatorString(@Nullable
                Comparator<? super String> aNestedComparator)

Comparator with default locale Collator and default sort order and a nested comparator.

Parameters:

aNestedComparator - The nested comparator to be invoked, when the main comparison resulted in 0.

ComparatorString

public ComparatorString(@Nonnull
                ESortOrder eSortOrder)

Comparator with default locale Collator.

Parameters:

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

ComparatorString

public ComparatorString(@Nonnull
                ESortOrder eSortOrder,
                @Nullable
                Comparator<? super String> aNestedComparator)

Comparator with default locale Collator and a nested comparator.

Parameters:

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

aNestedComparator - The nested comparator to be invoked, when the main comparison resulted in 0.

ComparatorString

public ComparatorString(@Nullable
                Locale aSortLocale)

Comparator with default sort order and specified sort locale.

Parameters:

aSortLocale - The locale to use. May be null.

ComparatorString

public ComparatorString(@Nullable
                Locale aSortLocale,
                @Nullable
                Comparator<? super String> aNestedComparator)

Comparator with default sort order but special locale and a nested comparator.

Parameters:

aSortLocale - The locale to use. May be null.

aNestedComparator - The nested comparator to be invoked, when the main comparison resulted in 0.

ComparatorString

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

Constructor with locale and sort order.

Parameters:

aSortLocale - The locale to use. May be null.

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

ComparatorString

public ComparatorString(@Nullable
                Locale aSortLocale,
                @Nonnull
                ESortOrder eSortOrder,
                @Nullable
                Comparator<? super String> aNestedComparator)

Constructor with locale and sort order and a nested comparator.

Parameters:

aSortLocale - The locale to use. May be null.

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

aNestedComparator - The nested comparator to be invoked, when the main comparison resulted in 0.

ComparatorString

public ComparatorString(@Nonnull
                Collator aCollator)

Constructor with Collator using the default sort order

Parameters:

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

ComparatorString

public ComparatorString(@Nonnull
                Collator aCollator,
                @Nullable
                Comparator<? super String> aNestedComparator)

Constructor with Collator using the default sort order and a nested comparator.

Parameters:

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

aNestedComparator - The nested comparator to be invoked, when the main comparison resulted in 0.

ComparatorString

public ComparatorString(@Nonnull
                Collator aCollator,
                @Nonnull
                ESortOrder eSortOrder)

Constructor with Collator and sort order.

Parameters:

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

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

ComparatorString

public ComparatorString(@Nonnull
                Collator aCollator,
                @Nonnull
                ESortOrder eSortOrder,
                @Nullable
                Comparator<? super String> aNestedComparator)

Constructor with Collator and sort order and a nested comparator.

Parameters:

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

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

aNestedComparator - The nested comparator to be invoked, when the main comparison resulted in 0.

Method Detail

asString

protected String asString(@Nullable
              String sValue)

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

Parameters:

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