com.phloc.commons.compare

Class ComparatorAsString

java.lang.Object

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

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

com.phloc.commons.compare.ComparatorAsString

All Implemented Interfaces:

Serializable, Comparator<Object>

public class ComparatorAsString
extends AbstractCollationComparator<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
ComparatorAsString() Comparator with default locale Collator and default sort order.
ComparatorAsString(Collator aCollator) Constructor with Collator using the default sort order
ComparatorAsString(Collator aCollator, Comparator<? super Object> aNestedComparator) Constructor with Collator using the default sort order and a nested comparator.
ComparatorAsString(Collator aCollator, ESortOrder eSortOrder) Constructor with Collator and sort order.
ComparatorAsString(Collator aCollator, ESortOrder eSortOrder, Comparator<? super Object> aNestedComparator) Constructor with Collator and sort order and a nested comparator.
ComparatorAsString(Comparator<? super Object> aNestedComparator) Comparator with default locale Collator and default sort order and a nested comparator.
ComparatorAsString(ESortOrder eSortOrder) Comparator with default locale Collator.
ComparatorAsString(ESortOrder eSortOrder, Comparator<? super Object> aNestedComparator) Comparator with default locale Collator and a nested comparator.
ComparatorAsString(Locale aSortLocale) Comparator with default sort order and specified sort locale.
ComparatorAsString(Locale aSortLocale, Comparator<? super Object> aNestedComparator) Comparator with default sort order but special locale and a nested comparator.
ComparatorAsString(Locale aSortLocale, ESortOrder eSortOrder) Constructor with locale and sort order.
ComparatorAsString(Locale aSortLocale, ESortOrder eSortOrder, Comparator<? super Object> aNestedComparator) Constructor with locale and sort order and a nested comparator.

Method Summary

Methods

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

ComparatorAsString

public ComparatorAsString()

Comparator with default locale Collator and default sort order.

ComparatorAsString

public ComparatorAsString(@Nullable
                  Comparator<? super Object> 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.

ComparatorAsString

public ComparatorAsString(@Nonnull
                  ESortOrder eSortOrder)

Comparator with default locale Collator.

Parameters:

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

ComparatorAsString

public ComparatorAsString(@Nonnull
                  ESortOrder eSortOrder,
                  @Nullable
                  Comparator<? super Object> 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.

ComparatorAsString

public ComparatorAsString(@Nullable
                  Locale aSortLocale)

Comparator with default sort order and specified sort locale.

Parameters:

aSortLocale - The locale to use. May be null.

ComparatorAsString

public ComparatorAsString(@Nullable
                  Locale aSortLocale,
                  @Nullable
                  Comparator<? super Object> 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.

ComparatorAsString

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

ComparatorAsString

public ComparatorAsString(@Nullable
                  Locale aSortLocale,
                  @Nonnull
                  ESortOrder eSortOrder,
                  @Nullable
                  Comparator<? super Object> 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.

ComparatorAsString

public ComparatorAsString(@Nonnull
                  Collator aCollator)

Constructor with Collator using the default sort order

Parameters:

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

ComparatorAsString

public ComparatorAsString(@Nonnull
                  Collator aCollator,
                  @Nullable
                  Comparator<? super Object> 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.

ComparatorAsString

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

ComparatorAsString

public ComparatorAsString(@Nonnull
                  Collator aCollator,
                  @Nonnull
                  ESortOrder eSortOrder,
                  @Nullable
                  Comparator<? super Object> 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
              Object aValue)

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

Parameters:

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