ComparatorCompat (Lightweight-Stream-API 1.1.6 API)

java.lang.Object
- com.annimon.stream.ComparatorCompat

```
public final class ComparatorCompat
extends Object
```
Backported default and static methods from Java 8 Comparator interface.

Since:

1.1.6

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ComparatorCompat.Chain<T>
Class that helps to build new comparators.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ComparatorCompat.Chain<T>` Class that helps to build new comparators.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static <T> ComparatorCompat.Chain<T>`	`chain(Comparator<T> comparator)` Returns a `ComparatorCompat.Chain` class instance for build comparators.
`static <T,U extends Comparable<? super U>> Comparator<T>`	`comparing(Function<? super T,? extends U> keyExtractor)` Returns a comparator that uses a function that extracts a `Comparable` sort key to be compared.
`static <T,U> Comparator<T>`	`comparing(Function<? super T,? extends U> keyExtractor, Comparator<? super U> keyComparator)` Returns a comparator that uses a function that extracts a sort key to be compared with the specified comparator.
`static <T> Comparator<T>`	`comparingDouble(ToDoubleFunction<? super T> keyExtractor)` Returns a comparator that uses a function that extracts a `double` sort key to be compared.
`static <T> Comparator<T>`	`comparingInt(ToIntFunction<? super T> keyExtractor)` Returns a comparator that uses a function that extracts an `int` sort key to be compared.
`static <T> Comparator<T>`	`comparingLong(ToLongFunction<? super T> keyExtractor)` Returns a comparator that uses a function that extracts a `long` sort key to be compared.
`static <T extends Comparable<? super T>> Comparator<T>`	`naturalOrder()` Returns a comparator with natural order.
`static <T> Comparator<T>`	`nullsFirst()` Returns a comparator that considers `null` to be less than non-null and all non-null values to be equal.
`static <T> Comparator<T>`	`nullsFirst(Comparator<? super T> comparator)` Returns a comparator that considers `null` to be less than non-null.
`static <T> Comparator<T>`	`nullsLast()` Returns a comparator that considers `null` to be greater than non-null and all non-null values to be equal.
`static <T> Comparator<T>`	`nullsLast(Comparator<? super T> comparator)` Returns a comparator that considers `null` to be greater than non-null.
`static <T> Comparator<T>`	`reversed(Comparator<T> comparator)` Returns a comparator that reverses the order of the specified comparator.
`static <T extends Comparable<? super T>> Comparator<T>`	`reverseOrder()` Returns a comparator with reverse order.
`static <T> Comparator<T>`	`thenComparing(Comparator<? super T> c1, Comparator<? super T> c2)` Returns a comparator that uses `c2` comparator if `c1` comparator considers two elements equal.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - naturalOrder
```
public static <T extends Comparable<? super T>> Comparator<T> naturalOrder()
```
    Returns a comparator with natural order.
    
    Type Parameters:
    
    T - the type of the objects compared by the comparator
    
    Returns:
    
    a comparator
  - reverseOrder
```
public static <T extends Comparable<? super T>> Comparator<T> reverseOrder()
```
    Returns a comparator with reverse order.
    
    Type Parameters:
    
    T - the type of the objects compared by the comparator
    
    Returns:
    
    a comparator
    
    See Also:
    
    Collections.reverseOrder()
  - reversed
```
public static <T> Comparator<T> reversed(Comparator<T> comparator)
```
    Returns a comparator that reverses the order of the specified comparator. If the specified comparator is null, this method is equivalent to reverseOrder().
    
    Type Parameters:
    
    T - the type of the objects compared by the comparator
    
    Parameters:
    
    comparator - a comparator to be reversed
    
    Returns:
    
    a comparator
    
    Throws:
    
    NullPointerException - if comparator is null
    
    See Also:
    
    Collections.reverseOrder(java.util.Comparator)
  - thenComparing
```
public static <T> Comparator<T> thenComparing(Comparator<? super T> c1,
                                              Comparator<? super T> c2)
```
    Returns a comparator that uses c2 comparator if c1 comparator considers two elements equal.
    
    Type Parameters:
    
    T - the type of the objects compared by the comparators
    
    Parameters:
    
    c1 - a first comparator
    
    c2 - a second comparator
    
    Returns:
    
    a comparator
    
    Throws:
    
    NullPointerException - if c1 or c2 is null
  - comparing
```
public static <T,U> Comparator<T> comparing(Function<? super T,? extends U> keyExtractor,
                                            Comparator<? super U> keyComparator)
```
    Returns a comparator that uses a function that extracts a sort key to be compared with the specified comparator.
    
    Type Parameters:
    
    T - the type of the objects compared by the comparator
    
    U - the type of the sort key
    
    Parameters:
    
    keyExtractor - the function that extracts the sort key
    
    keyComparator - the comparator used to compare the sort key
    
    Returns:
    
    a comparator
    
    Throws:
    
    NullPointerException - if keyExtractor or keyComparator is null
  - comparing
```
public static <T,U extends Comparable<? super U>> Comparator<T> comparing(Function<? super T,? extends U> keyExtractor)
```
    Returns a comparator that uses a function that extracts a Comparable sort key to be compared.
    
    Type Parameters:
    
    T - the type of the objects compared by the comparator
    
    U - the type of the sort key
    
    Parameters:
    
    keyExtractor - the function that extracts the sort key
    
    Returns:
    
    a comparator
    
    Throws:
    
    NullPointerException - if keyExtractor is null
  - comparingInt
```
public static <T> Comparator<T> comparingInt(ToIntFunction<? super T> keyExtractor)
```
    Returns a comparator that uses a function that extracts an int sort key to be compared.
    
    Type Parameters:
    
    T - the type of the objects compared by the comparator
    
    Parameters:
    
    keyExtractor - the function that extracts the sort key
    
    Returns:
    
    a comparator
    
    Throws:
    
    NullPointerException - if keyExtractor is null
  - comparingLong
```
public static <T> Comparator<T> comparingLong(ToLongFunction<? super T> keyExtractor)
```
    Returns a comparator that uses a function that extracts a long sort key to be compared.
    
    Type Parameters:
    
    T - the type of the objects compared by the comparator
    
    Parameters:
    
    keyExtractor - the function that extracts the sort key
    
    Returns:
    
    a comparator
    
    Throws:
    
    NullPointerException - if keyExtractor is null
  - comparingDouble
```
public static <T> Comparator<T> comparingDouble(ToDoubleFunction<? super T> keyExtractor)
```
    Returns a comparator that uses a function that extracts a double sort key to be compared.
    
    Type Parameters:
    
    T - the type of the objects compared by the comparator
    
    Parameters:
    
    keyExtractor - the function that extracts the sort key
    
    Returns:
    
    a comparator
    
    Throws:
    
    NullPointerException - if keyExtractor is null
  - nullsFirst
```
public static <T> Comparator<T> nullsFirst()
```
    Returns a comparator that considers null to be less than non-null and all non-null values to be equal.
    
    Type Parameters:
    
    T - the type of the objects compared by the comparator
    
    Returns:
    
    a comparator
  - nullsFirst
```
public static <T> Comparator<T> nullsFirst(Comparator<? super T> comparator)
```
    Returns a comparator that considers null to be less than non-null. If the specified comparator is null, then the returned comparator considers all non-null values to be equal.
    
    Type Parameters:
    
    T - the type of the objects compared by the comparator
    
    Parameters:
    
    comparator - a comparator for comparing non-null values
    
    Returns:
    
    a comparator
  - nullsLast
```
public static <T> Comparator<T> nullsLast()
```
    Returns a comparator that considers null to be greater than non-null and all non-null values to be equal.
    
    Type Parameters:
    
    T - the type of the objects compared by the comparator
    
    Returns:
    
    a comparator
  - nullsLast
```
public static <T> Comparator<T> nullsLast(Comparator<? super T> comparator)
```
    Returns a comparator that considers null to be greater than non-null. If the specified comparator is null, then the returned comparator considers all non-null values to be equal.
    
    Type Parameters:
    
    T - the type of the objects compared by the comparator
    
    Parameters:
    
    comparator - a comparator for comparing non-null values
    
    Returns:
    
    a comparator
  - chain
```
public static <T> ComparatorCompat.Chain<T> chain(Comparator<T> comparator)
```
    Returns a ComparatorCompat.Chain class instance for build comparators.
    
    Type Parameters:
    
    T - the type of the objects compared by the comparator
    
    Parameters:
    
    comparator - the comparator to be chained
    
    Returns:
    
    a Chain instance

Class ComparatorCompat

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

naturalOrder

reverseOrder

reversed

thenComparing

comparing

comparing

comparingInt

comparingLong

comparingDouble

nullsFirst

nullsFirst

nullsLast

nullsLast

chain