IntComparator (dxlib 3.341)

```
public interface IntComparator
```
A comparison function, which imposes a total ordering on some collection of ints. Comparators can be passed to a sort method (such as QuickSort.sort) to allow precise control over the sort order.
The purpose of this function is to allow non-trivial ordering of ints which depend on some external data. For example when ints are some identifiers (pseudo-references) of actual data.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`int`	`compare(int i1, int i2)` Compares its two arguments for order.
`static <K extends Comparable<? super K>> IntComparator`	`comparing(IntFunction<? extends K> keyExtractor)` Accepts a function that extracts a comparable sort, and returns a comparator that compares by an extracted comparable sort key.
`static <K> IntComparator`	`comparing(IntFunction<? extends K> keyExtractor, Comparator<? super K> keyComparator)` Accepts a function that extracts a sort key and a sort key comparator, and returns a comparator that compares by an extracted sort key using the specified sort key comparator.
`static IntComparator`	`comparingDouble(IntToDoubleFunction keyExtractor)` Accepts a function that extracts a double sort key, and returns a comparator that compares by an extracted double sort key.
`static IntComparator`	`comparingInt(IntUnaryOperator keyExtractor)` Accepts a function that extracts an int sort key, and returns a comparator that compares by an extracted int sort key.
`static IntComparator`	`comparingLong(IntToLongFunction keyExtractor)` Accepts a function that extracts a long sort key, and returns a comparator that compares by an extracted long sort key.
`default IntComparator`	`reversed()` Returns a comparator that imposes the reverse ordering of this comparator.
`default IntComparator`	`thenComparing(IntComparator other)` Returns a lexicographic-order comparator with another comparator.
`default <K extends Comparable<? super K>> IntComparator`	`thenComparing(IntFunction<? extends K> keyExtractor)` Returns a lexicographic-order comparator with a function that extracts a comparable sort key.
`default <K> IntComparator`	`thenComparing(IntFunction<? extends K> keyExtractor, Comparator<? super K> keyComparator)` Returns a lexicographic-order comparator with a function that extracts a sort key to be compared with the given sort key comparator.
`default IntComparator`	`thenComparingDouble(IntToDoubleFunction keyExtractor)` Returns a lexicographic-order comparator with a function that extracts a double sort key.
`default IntComparator`	`thenComparingInt(IntUnaryOperator keyExtractor)` Returns a lexicographic-order comparator with a function that extracts an int sort key.
`default IntComparator`	`thenComparingLong(IntToLongFunction keyExtractor)` Returns a lexicographic-order comparator with a function that extracts a long sort key.

- Method Detail
  - compare
```
int compare(int i1,
            int i2)
```
    Compares its two 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.
    
    Parameters:
    
    i1 - the first int to be compared.
    
    i2 - the second int to be compared.
    
    Returns:
    
    a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.
  - reversed
```
default IntComparator reversed()
```
    Returns a comparator that imposes the reverse ordering of this comparator.
    
    Returns:
    
    a comparator that imposes the reverse ordering of this comparator.
  - thenComparing
```
default IntComparator thenComparing(IntComparator other)
```
    Returns a lexicographic-order comparator with another comparator. If this comparator considers two elements equal, i.e. compare(i1, i2) == 0, then other comparator is used to determine the order.
    The returned comparator is serializable if the specified comparator is also serializable.
    
    Parameters:
    
    other - the other comparator to be used when this comparator compares two ints that are equal.
    
    Returns:
    
    a lexicographic-order comparator composed of this comparator and then the other comparator.
    
    Throws:
    
    NullPointerException - if the argument is null.
  - thenComparing
```
default <K> IntComparator thenComparing(IntFunction<? extends K> keyExtractor,
                                        Comparator<? super K> keyComparator)
```
    Returns a lexicographic-order comparator with a function that extracts a sort key to be compared with the given sort key comparator.
    This default implementation delegates to thenComparing(comparing(keyExtractor, keyComparator)) expression.
    
    Type Parameters:
    
    K - the type of the sort key.
    
    Parameters:
    
    keyExtractor - the function used to extract the sort key.
    
    keyComparator - the comparator used to compare the sort key.
    
    Returns:
    
    a lexicographic-order comparator composed of this comparator and then comparing an extracted sort key using the specified sort key comparator.
    
    Throws:
    
    NullPointerException - if either argument is null.
  - thenComparing
```
default <K extends Comparable<? super K>> IntComparator thenComparing(IntFunction<? extends K> keyExtractor)
```
    Returns a lexicographic-order comparator with a function that extracts a comparable sort key.
    This default implementation delegates to thenComparing(comparing(keyExtractor)) expression.
    
    Type Parameters:
    
    K - the type of the comparable sort key.
    
    Parameters:
    
    keyExtractor - the function used to extract the comparable sort key.
    
    Returns:
    
    a lexicographic-order comparator composed of this comparator and then comparing an extracted comparable sort key.
    
    Throws:
    
    NullPointerException - if the argument is null.
  - thenComparingInt
```
default IntComparator thenComparingInt(IntUnaryOperator keyExtractor)
```
    Returns a lexicographic-order comparator with a function that extracts an int sort key.
    This default implementation delegates to thenComparing(comparing(keyExtractor)) expression.
    
    Parameters:
    
    keyExtractor - the function used to extract the int sort key.
    
    Returns:
    
    a lexicographic-order comparator composed of this comparator and then comparing an extracted int sort key.
    
    Throws:
    
    NullPointerException - if the argument is null.
  - thenComparingLong
```
default IntComparator thenComparingLong(IntToLongFunction keyExtractor)
```
    Returns a lexicographic-order comparator with a function that extracts a long sort key.
    This default implementation delegates to thenComparing(comparing(keyExtractor)) expression.
    
    Parameters:
    
    keyExtractor - the function used to extract the long sort key.
    
    Returns:
    
    a lexicographic-order comparator composed of this comparator and then comparing an extracted long sort key.
    
    Throws:
    
    NullPointerException - if the argument is null.
  - thenComparingDouble
```
default IntComparator thenComparingDouble(IntToDoubleFunction keyExtractor)
```
    Returns a lexicographic-order comparator with a function that extracts a double sort key.
    This default implementation delegates to thenComparing(comparing(keyExtractor)) expression.
    
    Parameters:
    
    keyExtractor - the function used to extract the double sort key.
    
    Returns:
    
    a lexicographic-order comparator composed of this comparator and then comparing and extracted double sort key.
    
    Throws:
    
    NullPointerException - if the argument is null.
  - comparing
```
static <K> IntComparator comparing(IntFunction<? extends K> keyExtractor,
                                   Comparator<? super K> keyComparator)
```
    Accepts a function that extracts a sort key and a sort key comparator, and returns a comparator that compares by an extracted sort key using the specified sort key comparator.
    The returned comparator is serializable if the specified function and comparator are both serializable.
    
    Type Parameters:
    
    K - the type of the sort key.
    
    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 sort key using the specified sort key comparator.
    
    Throws:
    
    NullPointerException - if either argument is null.
  - comparing
```
static <K extends Comparable<? super K>> IntComparator comparing(IntFunction<? extends K> keyExtractor)
```
    Accepts a function that extracts a comparable sort, and returns a comparator that compares by an extracted comparable sort key.
    The returned comparator is serializable if the specified function is also serializable.
    
    Type Parameters:
    
    K - the type of the comparable sort key.
    
    Parameters:
    
    keyExtractor - the function used to extract the comparable sort key.
    
    Returns:
    
    a comparator that compares by an extracted comparable sort key.
    
    Throws:
    
    NullPointerException - if the argument is null.
  - comparingInt
```
static IntComparator comparingInt(IntUnaryOperator keyExtractor)
```
    Accepts a function that extracts an int sort key, and returns a comparator that compares by an extracted int sort key.
    The returned comparator is serializable if the specified function is also serializable.
    
    Parameters:
    
    keyExtractor - the function used to extract the int sort key.
    
    Returns:
    
    a comparator that compares by an extracted int sort key.
    
    Throws:
    
    NullPointerException - if the argument is null.
  - comparingLong
```
static IntComparator comparingLong(IntToLongFunction keyExtractor)
```
    Accepts a function that extracts a long sort key, and returns a comparator that compares by an extracted long 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 long sort key.
    
    Throws:
    
    NullPointerException - if the argument is null.
  - comparingDouble
```
static IntComparator comparingDouble(IntToDoubleFunction keyExtractor)
```
    Accepts a function that extracts a double sort key, and returns a comparator that compares by an extracted double 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 double sort key.
    
    Throws:
    
    NullPointerException - if the argument is null.

Interface IntComparator

Method Summary

Method Detail

compare

reversed

thenComparing

thenComparing

thenComparing

thenComparingInt

thenComparingLong

thenComparingDouble

comparing

comparing

comparingInt

comparingLong

comparingDouble