org.starchartlabs.alloy.core

Class Comparators

java.lang.Object

org.starchartlabs.alloy.core.Comparators

public final class Comparators
extends java.lang.Object

Provides methods for streamlining and reducing boilerplate in relation to use of Comparator instances

Since:

0.2.0

Method Summary

Modifier and Type	Method and Description
static <T> java.util.Comparator<java.util.Optional<T>>	emptiesFirst(java.util.Comparator<? super T> valueComparator)
static <T> java.util.Comparator<java.util.Optional<T>>	emptiesLast(java.util.Comparator<? super T> valueComparator)
static <T> boolean	isInOrder(java.lang.Iterable<? extends T> iterable, java.util.Comparator<T> comparator)
static <T> boolean	isInStrictOrder(java.lang.Iterable<? extends T> iterable, java.util.Comparator<T> comparator)

Methods inherited from class java.lang.Object

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

Method Detail

isInOrder

public static <T> boolean isInOrder(java.lang.Iterable<? extends T> iterable,
                                    java.util.Comparator<T> comparator)

Type Parameters:

T - The type being compared to determine ordering state

Parameters:

iterable - The ordered sequence of values to evaluate ordering on

comparator - Comparator used to determine ordering compliance

Returns:

true if each element in iterable after the first is greater than or equal to the element that preceded it, according to the specified comparator

Since:

0.2.0

isInStrictOrder

public static <T> boolean isInStrictOrder(java.lang.Iterable<? extends T> iterable,
                                          java.util.Comparator<T> comparator)

Type Parameters:

T - The type being compared to determine ordering state

Parameters:

iterable - The ordered sequence of values to evaluate strict ordering on

comparator - Comparator used to determine ordering compliance

Returns:

true if each element in iterable after the first is strictly greater than the element that preceded it, according to the specified comparator. Note that an element is not strictly after another if they are considered equivalent

Since:

0.2.0

emptiesFirst

public static <T> java.util.Comparator<java.util.Optional<T>> emptiesFirst(java.util.Comparator<? super T> valueComparator)

Type Parameters:

T - The type being compared

Parameters:

valueComparator - Comparator used to order present values

Returns:

A comparator of Optional values which treats Optional.empty() as less than all other values, and orders the rest using valueComparator on the contained value

Since:

0.2.0

emptiesLast

public static <T> java.util.Comparator<java.util.Optional<T>> emptiesLast(java.util.Comparator<? super T> valueComparator)

Type Parameters:

T - The type being compared

Parameters:

valueComparator - Comparator used to order present values

Returns:

A comparator of Optional values which treats Optional.empty() as greater than all other values, and orders the rest using valueComparator on the contained value

Since:

0.2.0