OptionalComparator (NoException 1.5.1 API)

Type Parameters:

T - see Comparator

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 OptionalComparator<T>
```
Variation of Comparator that returns OptionalInt instead of the raw value. OptionalComparator is typically obtained from ExceptionHandler.comparator(Comparator), in which case its return value is empty when the underlying Comparator throws an exception. See noexception tutorial.

See Also:

ExceptionHandler.comparator(Comparator), Comparator

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`OptionalInt`	`compare(T left, T right)` Variation of `Comparator.compare(Object, Object)` that returns `OptionalInt`.
`default Comparator<T>`	`orElse(int result)` Converts this `OptionalComparator` to plain `Comparator` using default value.
`default Comparator<T>`	`orElseGet(IntSupplier source)` Converts this `OptionalComparator` to plain `Comparator` using fallback `IntSupplier`.

- Method Detail
  - compare
```
OptionalInt compare(T left,
                    T right)
```
    Variation of Comparator.compare(Object, Object) that returns OptionalInt. If this OptionalComparator is obtained from ExceptionHandler.comparator(Comparator), the OptionalInt will be empty only if the underlying Comparator throws. Otherwise the returned OptionalInt just wraps the return value of underlying Comparator.
    
    Parameters:
    
    left - see Comparator.compare(Object, Object)
    
    right - see Comparator.compare(Object, Object)
    
    Returns:
    
    OptionalInt typically wrapping return value of Comparator.compare(Object, Object), or an empty OptionalInt (typically signifying an exception)
    
    See Also:
    
    ExceptionHandler.comparator(Comparator), Comparator.compare(Object, Object)
  - orElse
```
default Comparator<T> orElse(int result)
```
    Converts this OptionalComparator to plain Comparator using default value. The returned Comparator will unwrap present value from the OptionalInt if possible, or return result if the OptionalInt is empty.
    
    Parameters:
    
    result - default value to return instead of an empty OptionalInt
    
    Returns:
    
    plain Comparator that either unwraps OptionalInt or returns default value
    
    See Also:
    
    orElseGet(IntSupplier), OptionalInt.orElse(int)
  - orElseGet
```
default Comparator<T> orElseGet(IntSupplier source)
```
    Converts this OptionalComparator to plain Comparator using fallback IntSupplier. The returned Comparator will unwrap present value from the OptionalInt if possible, or fall back to calling source if the OptionalInt is empty.
    
    Parameters:
    
    source - IntSupplier to query for fallback value when OptionalInt is empty
    
    Returns:
    
    plain Comparator that either unwraps OptionalInt or falls back to source
    
    See Also:
    
    orElse(int), OptionalInt.orElseGet(IntSupplier)

Interface OptionalComparator<T>

Method Summary

Method Detail

compare

orElse

orElseGet