net.openhft.chronicle.core.util

Enum CharSequenceComparator

java.lang.Object

java.lang.Enum<CharSequenceComparator>

net.openhft.chronicle.core.util.CharSequenceComparator

All Implemented Interfaces:

Serializable, Comparable<CharSequenceComparator>, Comparator<CharSequence>

public enum CharSequenceComparator
extends Enum<CharSequenceComparator>
implements Comparator<CharSequence>

A singleton enum implementing a Comparator for comparing instances of CharSequence.

This comparator can be used, for instance, in sorting lists or performing binary searches where the elements are CharSequence instances. It performs a lexicographic comparison character by character.

Example:

     // Sorting a list of data objects based on CharSequence id before marshalling.
     dataList.sort(comparing(Data::getId, CharSequenceComparator.INSTANCE));

     // Finding an index within a sorted list based on a CharSequence key.
     int index = binarySearch(dataList, Data::getId, "DEF", CharSequenceComparator.INSTANCE);
 

See Also:

CharSequence, Comparator

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE The singleton instance of CharSequenceComparator.

Method Summary

Modifier and Type	Method and Description
int	compare(@NotNull CharSequence o1, @NotNull CharSequence o2) Compares two CharSequence instances lexicographically.
static CharSequenceComparator	valueOf(String name) Returns the enum constant of this type with the specified name.
static CharSequenceComparator[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, 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

Enum Constant Detail

INSTANCE

public static final CharSequenceComparator INSTANCE

The singleton instance of CharSequenceComparator.

Method Detail

values

public static CharSequenceComparator[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CharSequenceComparator c : CharSequenceComparator.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CharSequenceComparator valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

compare

public int compare(@NotNull
                   @NotNull CharSequence o1,
                   @NotNull
                   @NotNull CharSequence o2)

Compares two CharSequence instances lexicographically.

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

Specified by:

compare in interface Comparator<CharSequence>

Parameters:

o1 - The first CharSequence to be compared.

o2 - The second CharSequence to be compared.

Returns:

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

Throws:

AssertionError - if an IndexOutOfBoundsException occurs, indicating a bug.