io.earcam.unexceptional

Interface CheckedComparator<T>

Type Parameters:

T - the type to compare

All Superinterfaces:

CheckedToIntBiFunction<T,T>

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 CheckedComparator<T>
extends CheckedToIntBiFunction<T,T>

A checked equivalent of Comparator, also extends CheckedToIntBiFunction

Since:

0.2.0

See Also:

Comparator

Method Summary

Modifier and Type	Method and Description
default int	applyAsInt(T t, T u) Applies this function to the given arguments.
int	compare(T o1, T o2) See Comparator.compare(Object, Object)
static <T,U extends Comparable<? super U>> CheckedComparator<T>	comparing(CheckedFunction<? super T,? extends U> keyExtractor) See Comparator.comparing(java.util.function.Function)
static <T,U> CheckedComparator<T>	comparing(CheckedFunction<? super T,? extends U> keyExtractor, CheckedComparator<? super U> keyComparator) See Comparator.comparing(java.util.function.Function, Comparator)
static <T> CheckedComparator<T>	comparingDouble(CheckedToDoubleFunction<? super T> keyExtractor) See Comparator.comparingDouble(java.util.function.ToDoubleFunction)
static <T> CheckedComparator<T>	comparingInt(CheckedToIntFunction<? super T> keyExtractor) See Comparator.comparingInt(java.util.function.ToIntFunction)
static <T> CheckedComparator<T>	comparingLong(CheckedToLongFunction<? super T> keyExtractor) See Comparator.comparingLong(java.util.function.ToLongFunction)
default Comparator<T>	reversed() See Comparator.reversed()
default CheckedComparator<T>	thenComparing(CheckedComparator<? super T> other) See Comparator.thenComparing(Comparator)
default <U extends Comparable<? super U>> CheckedComparator<T>	thenComparing(CheckedFunction<? super T,? extends U> keyExtractor) See Comparator.thenComparing(java.util.function.Function)
default <U> CheckedComparator<T>	thenComparing(CheckedFunction<? super T,? extends U> keyExtractor, CheckedComparator<? super U> keyComparator) See Comparator.thenComparing(java.util.function.Function, Comparator)
default CheckedComparator<T>	thenComparingDouble(CheckedToDoubleFunction<? super T> keyExtractor) See Comparator.thenComparingDouble(java.util.function.ToDoubleFunction)
default CheckedComparator<T>	thenComparingInt(CheckedToIntFunction<? super T> keyExtractor) See Comparator.thenComparingInt(java.util.function.ToIntFunction)
default CheckedComparator<T>	thenComparingLong(CheckedToLongFunction<? super T> keyExtractor) See Comparator.thenComparingLong(java.util.function.ToLongFunction)

Method Detail

applyAsInt

default int applyAsInt(T t,
                       T u)
                throws Throwable

Description copied from interface: CheckedToIntBiFunction

Applies this function to the given arguments.

Specified by:

applyAsInt in interface CheckedToIntBiFunction<T,T>

Parameters:

t - the first function argument

u - the second function argument

Returns:

the function result

Throws:

Throwable - Any throwable

compare

int compare(T o1,
            T o2)
     throws Throwable

See Comparator.compare(Object, Object)

Parameters:

o1 - first object to compare.

o2 - second object to compare.

Returns:

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

Throws:

Throwable - any throwable

reversed

default Comparator<T> reversed()

See Comparator.reversed()

Returns:

an unchecked comparator of the reverse order to this

thenComparing

default CheckedComparator<T> thenComparing(@Nonnull
                                           CheckedComparator<? super T> other)

See Comparator.thenComparing(Comparator)

Parameters:

other - the next comparator to be chained (IFF this.compare(a, b) returns zero)

Returns:

the chained CheckedComparator

Throws:

NullPointerException - if other is null

thenComparing

default <U> CheckedComparator<T> thenComparing(CheckedFunction<? super T,? extends U> keyExtractor,
                                               CheckedComparator<? super U> keyComparator)

See Comparator.thenComparing(java.util.function.Function, Comparator)

Type Parameters:

U - the type of the sort key

Parameters:

keyExtractor - function used to extract sort key

keyComparator - comparator used to compare extracted key

Returns:

the chained CheckedComparator

See Also:

thenComparing(CheckedComparator)

thenComparing

default <U extends Comparable<? super U>> CheckedComparator<T> thenComparing(CheckedFunction<? super T,? extends U> keyExtractor)

See Comparator.thenComparing(java.util.function.Function)

Type Parameters:

U - the type of the Comparable sort key

Parameters:

keyExtractor - function used to extract sort key.

Returns:

the chained CheckedComparator

See Also:

thenComparing(CheckedComparator)

thenComparingInt

default CheckedComparator<T> thenComparingInt(CheckedToIntFunction<? super T> keyExtractor)

See Comparator.thenComparingInt(java.util.function.ToIntFunction)

Parameters:

keyExtractor - function used to extract primitive int sort key.

Returns:

the chained CheckedComparator

See Also:

thenComparing(CheckedComparator)

thenComparingLong

default CheckedComparator<T> thenComparingLong(CheckedToLongFunction<? super T> keyExtractor)

See Comparator.thenComparingLong(java.util.function.ToLongFunction)

Parameters:

keyExtractor - function used to extract primitive long sort key.

Returns:

the chained CheckedComparator

See Also:

thenComparing(CheckedComparator)

thenComparingDouble

default CheckedComparator<T> thenComparingDouble(CheckedToDoubleFunction<? super T> keyExtractor)

See Comparator.thenComparingDouble(java.util.function.ToDoubleFunction)

Parameters:

keyExtractor - function used to extract primitive double sort key.

Returns:

the chained CheckedComparator

See Also:

thenComparing(CheckedComparator)

comparing

@ParametersAreNonnullByDefault
static <T,U> CheckedComparator<T> comparing(CheckedFunction<? super T,? extends U> keyExtractor,
                                                                           CheckedComparator<? super U> keyComparator)

See Comparator.comparing(java.util.function.Function, Comparator)

Type Parameters:

T - the type of element to be compared

U - the type of the sort key

Parameters:

keyExtractor - function used to extract sort key.

keyComparator - comparator used to compare extracted key.

Returns:

a comparator that compares by an extracted key using the specified CheckedComparator.

Throws:

NullPointerException - if either argument is null.

comparing

static <T,U extends Comparable<? super U>> CheckedComparator<T> comparing(@Nonnull
                                                                          CheckedFunction<? super T,? extends U> keyExtractor)

See Comparator.comparing(java.util.function.Function)

Type Parameters:

T - the type of element to be compared.

U - the type of the sort key.

Parameters:

keyExtractor - the function used to extract the sort key.

Returns:

a comparator that compares by an extracted key.

Throws:

NullPointerException - if the argument is null.

comparingInt

static <T> CheckedComparator<T> comparingInt(@Nonnull
                                             CheckedToIntFunction<? super T> keyExtractor)

See Comparator.comparingInt(java.util.function.ToIntFunction)

Type Parameters:

T - the type of element to be compared.

Parameters:

keyExtractor - the function used to extract primitive int sort key.

Returns:

a checked comparator that compares by an extracted key.

Throws:

NullPointerException - if the argument is null.

See Also:

comparing(CheckedFunction)

comparingLong

static <T> CheckedComparator<T> comparingLong(@Nonnull
                                              CheckedToLongFunction<? super T> keyExtractor)

See Comparator.comparingLong(java.util.function.ToLongFunction)

Type Parameters:

T - the type of element to be compared.

Parameters:

keyExtractor - the function used to extract primitive long sort key.

Returns:

a checked comparator that compares by an extracted key.

Throws:

NullPointerException - if the argument is null.

See Also:

comparing(CheckedFunction)

comparingDouble

static <T> CheckedComparator<T> comparingDouble(@Nonnull
                                                CheckedToDoubleFunction<? super T> keyExtractor)

See Comparator.comparingDouble(java.util.function.ToDoubleFunction)

Type Parameters:

T - the type of element to be compared.

Parameters:

keyExtractor - the function used to extract primitive double sort key.

Returns:

a checked comparator that compares by an extracted key.

Throws:

NullPointerException - if the argument is null.

See Also:

comparing(CheckedFunction)