com.helger.commons.error

Class ComparatorHasErrorID<DATATYPE extends IHasErrorID>

java.lang.Object

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

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

com.helger.commons.error.ComparatorHasErrorID<DATATYPE>

All Implemented Interfaces:

Serializable, Comparator<DATATYPE>

public class ComparatorHasErrorID<DATATYPE extends IHasErrorID>
extends AbstractCollationComparator<DATATYPE>

Special comparator that compares based on an error ID

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

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

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

mainCompare, toString

Methods inherited from class com.helger.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

comparing, comparing, comparingDouble, comparingInt, comparingLong, equals, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Constructor Detail

ComparatorHasErrorID

public ComparatorHasErrorID()

Comparator with default locale Collator and default sort order.

ComparatorHasErrorID

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

ComparatorHasErrorID

public ComparatorHasErrorID(@Nonnull
                            ESortOrder eSortOrder)

Comparator with default locale Collator.

Parameters:

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

ComparatorHasErrorID

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

ComparatorHasErrorID

public ComparatorHasErrorID(@Nullable
                            Locale aSortLocale)

Comparator with default sort order and specified sort locale.

Parameters:

aSortLocale - The locale to use. May be null.

ComparatorHasErrorID

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

ComparatorHasErrorID

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

ComparatorHasErrorID

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

ComparatorHasErrorID

public ComparatorHasErrorID(@Nonnull
                            Collator aCollator)

Constructor with Collator using the default sort order

Parameters:

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

ComparatorHasErrorID

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

ComparatorHasErrorID

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

ComparatorHasErrorID

public ComparatorHasErrorID(@Nonnull
                            Collator aCollator,
                            @Nonnull
                            ESortOrder eSortOrder,
                            @Nullable
                            Comparator<? super DATATYPE> 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

@Nullable
protected String asString(@Nonnull
                                     DATATYPE aObject)

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<DATATYPE extends IHasErrorID>

Parameters:

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