com.annimon.stream

Class ComparatorCompat.Chain<T>

java.lang.Object

com.annimon.stream.ComparatorCompat.Chain<T>

Type Parameters:

T - the type of the objects compared by the comparator

Enclosing class:

ComparatorCompat

public static class ComparatorCompat.Chain<T>
extends Object

Class that helps to build new comparators.

Method Summary

Modifier and Type	Method and Description
Comparator<T>	comparator() Returns a chained Comparator.
ComparatorCompat.Chain<T>	reversed() Reverses the order of comparator.
ComparatorCompat.Chain<T>	thenComparing(Comparator<? super T> other) Adds the given comparator to the chain.
<U extends Comparable<? super U>> ComparatorCompat.Chain<T>	thenComparing(Function<? super T,? extends U> keyExtractor) Adds the comparator, that uses a function for extract a Comparable sort key, to the chain.
<U> ComparatorCompat.Chain<T>	thenComparing(Function<? super T,? extends U> keyExtractor, Comparator<? super U> keyComparator) Adds the comparator, that uses a function for extract a sort key, to the chain.
ComparatorCompat.Chain<T>	thenComparingDouble(ToDoubleFunction<? super T> keyExtractor) Adds the comparator, that uses a function for extract a double sort key, to the chain.
ComparatorCompat.Chain<T>	thenComparingInt(ToIntFunction<? super T> keyExtractor) Adds the comparator, that uses a function for extract an int sort key, to the chain.
ComparatorCompat.Chain<T>	thenComparingLong(ToLongFunction<? super T> keyExtractor) Adds the comparator, that uses a function for extract a long sort key, to the chain.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

reversed

public ComparatorCompat.Chain<T> reversed()

Reverses the order of comparator.

Returns:

the new Chain instance

See Also:

ComparatorCompat.reverseOrder()

thenComparing

public ComparatorCompat.Chain<T> thenComparing(Comparator<? super T> other)

Adds the given comparator to the chain.

Parameters:

other - the other comparator to be used when chained comparator compares two objects that are equal

Returns:

the new Chain instance

See Also:

ComparatorCompat.thenComparing(java.util.Comparator, java.util.Comparator)

thenComparing

public <U> ComparatorCompat.Chain<T> thenComparing(Function<? super T,? extends U> keyExtractor,
                                                   Comparator<? super U> keyComparator)

Adds the comparator, that uses a function for extract a sort key, to the chain.

Type Parameters:

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:

the new Chain instance

thenComparing

public <U extends Comparable<? super U>> ComparatorCompat.Chain<T> thenComparing(Function<? super T,? extends U> keyExtractor)

Adds the comparator, that uses a function for extract a Comparable sort key, to the chain.

Type Parameters:

U - the type of the sort key

Parameters:

keyExtractor - the function that extracts the sort key

Returns:

the new Chain instance

thenComparingInt

public ComparatorCompat.Chain<T> thenComparingInt(ToIntFunction<? super T> keyExtractor)

Adds the comparator, that uses a function for extract an int sort key, to the chain.

Parameters:

keyExtractor - the function that extracts the sort key

Returns:

the new Chain instance

thenComparingLong

public ComparatorCompat.Chain<T> thenComparingLong(ToLongFunction<? super T> keyExtractor)

Adds the comparator, that uses a function for extract a long sort key, to the chain.

Parameters:

keyExtractor - the function that extracts the sort key

Returns:

the new Chain instance

thenComparingDouble

public ComparatorCompat.Chain<T> thenComparingDouble(ToDoubleFunction<? super T> keyExtractor)

Adds the comparator, that uses a function for extract a double sort key, to the chain.

Parameters:

keyExtractor - the function that extracts the sort key

Returns:

the new Chain instance

comparator

public Comparator<T> comparator()

Returns a chained Comparator.

Returns:

a comparator