CheckedComparator (io.earcam.unexceptional 1.0.0 API)

Type Parameters:

T - the type to compare

E - the type of Throwable declared

All Superinterfaces:

CheckedToIntBiFunction<T,T,E>

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,E extends Throwable>
extends CheckedToIntBiFunction<T,T,E>
```
A checked equivalent of Comparator, also extends CheckedToIntBiFunction

Since:

0.2.0

See Also:

Comparator

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
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>,E extends Throwable> CheckedComparator<T,E>`	`comparing(CheckedFunction<? super T,? extends U,? extends E> keyExtractor)` See `Comparator.comparing(java.util.function.Function)`
`static <T,U,E extends Throwable> CheckedComparator<T,E>`	`comparing(CheckedFunction<? super T,? extends U,? extends E> keyExtractor, CheckedComparator<? super U,? extends E> keyComparator)` See `Comparator.comparing(java.util.function.Function, Comparator)`
`static <T,E extends Throwable> CheckedComparator<T,E>`	`comparingDouble(CheckedToDoubleFunction<? super T,? extends E> keyExtractor)` See `Comparator.comparingDouble(java.util.function.ToDoubleFunction)`
`static <T,E extends Throwable> CheckedComparator<T,E>`	`comparingInt(CheckedToIntFunction<? super T,? extends E> keyExtractor)` See `Comparator.comparingInt(java.util.function.ToIntFunction)`
`static <T,E extends Throwable> CheckedComparator<T,E>`	`comparingLong(CheckedToLongFunction<? super T,? extends E> keyExtractor)` See `Comparator.comparingLong(java.util.function.ToLongFunction)`
`default Comparator<T>`	`reversed()` See `Comparator.reversed()`
`default CheckedComparator<T,E>`	`thenComparing(CheckedComparator<? super T,? extends E> other)` See `Comparator.thenComparing(Comparator)`
`default <U extends Comparable<? super U>> CheckedComparator<T,E>`	`thenComparing(CheckedFunction<? super T,? extends U,E> keyExtractor)` See `Comparator.thenComparing(java.util.function.Function)`
`default <U> CheckedComparator<T,E>`	`thenComparing(CheckedFunction<? super T,? extends U,E> keyExtractor, CheckedComparator<? super U,E> keyComparator)` See `Comparator.thenComparing(java.util.function.Function, Comparator)`
`default CheckedComparator<T,E>`	`thenComparingDouble(CheckedToDoubleFunction<? super T,? extends E> keyExtractor)` See `Comparator.thenComparingDouble(java.util.function.ToDoubleFunction)`
`default CheckedComparator<T,E>`	`thenComparingInt(CheckedToIntFunction<? super T,? extends E> keyExtractor)` See `Comparator.thenComparingInt(java.util.function.ToIntFunction)`
`default CheckedComparator<T,E>`	`thenComparingLong(CheckedToLongFunction<? super T,? extends E> keyExtractor)` See `Comparator.thenComparingLong(java.util.function.ToLongFunction)`

- Method Detail
  - applyAsInt
```
default int applyAsInt(T t,
                       T u)
                throws E extends Throwable
```
    Description copied from interface: CheckedToIntBiFunction
    
    Applies this function to the given arguments.
    
    Specified by:
    
    applyAsInt in interface CheckedToIntBiFunction<T,T,E extends Throwable>
    
    Parameters:
    
    t - the first function argument
    
    u - the second function argument
    
    Returns:
    
    the function result
    
    Throws:
    
    E extends Throwable
  - compare
```
int compare(T o1,
            T o2)
     throws E extends 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,E> thenComparing(CheckedComparator<? super T,? extends E> 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,E> thenComparing(CheckedFunction<? super T,? extends U,E> keyExtractor,
                                                 CheckedComparator<? super U,E> 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,E> thenComparing(CheckedFunction<? super T,? extends U,E> 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,E> thenComparingInt(CheckedToIntFunction<? super T,? extends E> 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,E> thenComparingLong(CheckedToLongFunction<? super T,? extends E> 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,E> thenComparingDouble(CheckedToDoubleFunction<? super T,? extends E> 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
```
static <T,U,E extends Throwable> CheckedComparator<T,E> comparing(CheckedFunction<? super T,? extends U,? extends E> keyExtractor,
                                                                  CheckedComparator<? super U,? extends E> 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>,E extends Throwable> CheckedComparator<T,E> comparing(CheckedFunction<? super T,? extends U,? extends E> 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,E extends Throwable> CheckedComparator<T,E> comparingInt(CheckedToIntFunction<? super T,? extends E> 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,E extends Throwable> CheckedComparator<T,E> comparingLong(CheckedToLongFunction<? super T,? extends E> 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,E extends Throwable> CheckedComparator<T,E> comparingDouble(CheckedToDoubleFunction<? super T,? extends E> 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)

Interface CheckedComparator<T,E extends Throwable>

Method Summary

Method Detail

applyAsInt

compare

reversed

thenComparing

thenComparing

thenComparing

thenComparingInt

thenComparingLong

thenComparingDouble

comparing

comparing

comparingInt

comparingLong

comparingDouble