Package it.unimi.dsi.fastutil.chars

Interface CharComparator

All Superinterfaces:

Comparator<Character>

All Known Implementing Classes:

AbstractCharComparator

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface CharComparator
extends Comparator<Character>

A type-specific Comparator; provides methods to compare two primitive types both as objects and as primitive types.

Note that fastutil provides a corresponding abstract class that can be used to implement this interface just by specifying the type-specific comparator.

See Also:

• Comparator

Method Summary

Modifier and Type	Method	Description
int	compare(char k1, char k2)	Compares its two primitive-type arguments for order.
default int	compare(Character ok1, Character ok2)	Deprecated. Please use the corresponding type-specific method instead.
static <U extends Comparable<? super U>> CharComparator	comparing(Char2ObjectFunction<? extends U> keyExtractor)	Accepts a function that extracts a Comparable sort key from a primitive key, and returns a comparator that compares by that sort key.
static <U extends Comparable<? super U>> CharComparator	comparing(Char2ObjectFunction<? extends U> keyExtractor, Comparator<? super U> keyComparator)	Accepts a function that extracts a sort key from a primitive key, and returns a comparator that compares by that sort key using the specified Comparator.
static CharComparator	comparingDouble(Char2DoubleFunction keyExtractor)	Accepts a function that extracts an double sort key from a primitive key, and returns a comparator that compares by that sort key.
static CharComparator	comparingInt(Char2IntFunction keyExtractor)	Accepts a function that extracts an int sort key from a primitive key, and returns a comparator that compares by that sort key.
static CharComparator	comparingLong(Char2LongFunction keyExtractor)	Accepts a function that extracts an long sort key from a primitive key, and returns a comparator that compares by that sort key.
default CharComparator	reversed()
default CharComparator	thenComparing(CharComparator second)	Return a new comparator that first uses this comparator, then uses the second comparator if this comparator compared the two elements as equal.
default Comparator<Character>	thenComparing(Comparator<? super Character> second)

Methods inherited from interface java.util.Comparator

equals, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Method Details

compare

int compare(char k1,
 char k2)

Compares its two primitive-type arguments for order. Returns a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

Returns:

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

See Also:

• Comparator

reversed

default CharComparator reversed()

Specified by:

reversed in interface Comparator<Character>

compare

@Deprecated
default int compare(Character ok1,
 Character ok2)

Deprecated.

Please use the corresponding type-specific method instead.

Specified by:

compare in interface Comparator<Character>

Implementation Specification:

This implementation delegates to the corresponding type-specific method.

thenComparing

default CharComparator thenComparing(CharComparator second)

Return a new comparator that first uses this comparator, then uses the second comparator if this comparator compared the two elements as equal.

See Also:

• Comparator.thenComparing(Comparator)

thenComparing

default Comparator<Character> thenComparing(Comparator<? super Character> second)

Specified by:

thenComparing in interface Comparator<Character>

comparing

static <U extends Comparable<? super U>>
CharComparator comparing(Char2ObjectFunction<? extends U> keyExtractor)

Accepts a function that extracts a Comparable sort key from a primitive key, and returns a comparator that compares by that sort key.

The returned comparator is serializable if the specified function is also serializable.

Parameters:

keyExtractor - the function used to extract the Comparable sort key

Returns:

a comparator that compares by an extracted key

Throws:

NullPointerException - if keyExtractor is null

comparing

static <U extends Comparable<? super U>>
CharComparator comparing(Char2ObjectFunction<? extends U> keyExtractor,
 Comparator<? super U> keyComparator)

Accepts a function that extracts a sort key from a primitive key, and returns a comparator that compares by that sort key using the specified Comparator.

The returned comparator is serializable if the specified function and comparator are both serializable.

Parameters:

keyExtractor - the function used to extract the sort key

keyComparator - the Comparator used to compare the sort key

Returns:

a comparator that compares by an extracted key using the specified Comparator

Throws:

NullPointerException - if keyExtractor or keyComparator are null

comparingInt

static CharComparator comparingInt(Char2IntFunction keyExtractor)

Accepts a function that extracts an int sort key from a primitive key, and returns a comparator that compares by that sort key.

The returned comparator is serializable if the specified function is also serializable.

Parameters:

keyExtractor - the function used to extract the integer sort key

Returns:

a comparator that compares by an extracted key

Throws:

NullPointerException - if keyExtractor is null

comparingLong

static CharComparator comparingLong(Char2LongFunction keyExtractor)

Accepts a function that extracts an long sort key from a primitive key, and returns a comparator that compares by that sort key.

The returned comparator is serializable if the specified function is also serializable.

Parameters:

keyExtractor - the function used to extract the long sort key

Returns:

a comparator that compares by an extracted key

Throws:

NullPointerException - if keyExtractor is null

comparingDouble

static CharComparator comparingDouble(Char2DoubleFunction keyExtractor)

Accepts a function that extracts an double sort key from a primitive key, and returns a comparator that compares by that sort key.

The returned comparator is serializable if the specified function is also serializable.

Parameters:

keyExtractor - the function used to extract the double sort key

Returns:

a comparator that compares by an extracted key

Throws:

NullPointerException - if keyExtractor is null