com.helger.commons.compare

Class ComparatorComparableNullAware<DATATYPE extends Comparable<? super DATATYPE>>

java.lang.Object

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

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

Type Parameters:

DATATYPE - Data type to compare

All Implemented Interfaces:

Serializable, Comparator<DATATYPE>

public class ComparatorComparableNullAware<DATATYPE extends Comparable<? super DATATYPE>>
extends AbstractComparator<DATATYPE>

This is another *lol* class: a Comparator for Comparable objects. In comparison to ComparatorComparable this class can handle null values.

Author:

Philip Helger

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_NULL_VALUES_COME_FIRST Default value wether null values come first or last

Constructor Summary

Constructors

Constructor and Description
ComparatorComparableNullAware() Comparator with default sort order.
ComparatorComparableNullAware(Comparator<? super DATATYPE> aNestedComparator) Comparator with default sort order and a nested comparator.
ComparatorComparableNullAware(ESortOrder eSortOrder) Constructor with sort order.
ComparatorComparableNullAware(ESortOrder eSortOrder, Comparator<? super DATATYPE> aNestedComparator) Comparator with sort order and a nested comparator.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isNullValuesComeFirst()
protected int	mainCompare(DATATYPE aElement1, DATATYPE aElement2)
ComparatorComparableNullAware<DATATYPE>	setNullValuesComeFirst(boolean bNullValuesComeFirst)

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

compare, getNestedComparator, getSortOrder, setSortOrder

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Comparator

equals

Field Detail

DEFAULT_NULL_VALUES_COME_FIRST

public static final boolean DEFAULT_NULL_VALUES_COME_FIRST

Default value wether null values come first or last

See Also:

Constant Field Values

Constructor Detail

ComparatorComparableNullAware

public ComparatorComparableNullAware()

Comparator with default sort order.

ComparatorComparableNullAware

public ComparatorComparableNullAware(@Nonnull
                             ESortOrder eSortOrder)

Constructor with sort order.

Parameters:

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

ComparatorComparableNullAware

public ComparatorComparableNullAware(@Nullable
                             Comparator<? super DATATYPE> aNestedComparator)

Comparator with default sort order and a nested comparator.

Parameters:

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

ComparatorComparableNullAware

public ComparatorComparableNullAware(@Nonnull
                             ESortOrder eSortOrder,
                             @Nullable
                             Comparator<? super DATATYPE> aNestedComparator)

Comparator with sort order 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.

Method Detail

isNullValuesComeFirst

public final boolean isNullValuesComeFirst()

setNullValuesComeFirst

@Nonnull
public final ComparatorComparableNullAware<DATATYPE> setNullValuesComeFirst(boolean bNullValuesComeFirst)

mainCompare

protected final int mainCompare(@Nullable
              DATATYPE aElement1,
              @Nullable
              DATATYPE aElement2)

Specified by:

mainCompare in class AbstractComparator<DATATYPE extends Comparable<? super DATATYPE>>

Parameters:

aElement1 - First element to compare. No information on the null status.

aElement2 - Second element to compare. No information on the null status.

Returns:

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