org.libj.util

Class FixedOrderComparator<T extends Comparable<? super T>>

java.lang.Object

org.libj.util.FixedOrderComparator<T>

Type Parameters:

T - The Comparable type of element to be compared.

All Implemented Interfaces:

Serializable, Comparator<T>

public class FixedOrderComparator<T extends Comparable<? super T>>
extends Object
implements Comparator<T>, Serializable

A Comparator that accepts a fixed definition of terms specifying an order. When compare(Comparable,Comparable) is invoked, the comparator first attempts to equate each argument to the order terms. If either argument is matched, the term's order determines the result of the comparison. If neither argument is matched, the result of the comparison is determined by with Comparable.compareTo(Object).

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FixedOrderComparator(T... order) Creates a new FixedOrderComparator with the specified order of terms.

Method Summary

Modifier and Type	Method and Description
int	compare(T o1, T o2)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Comparator

comparing, comparing, comparingDouble, comparingInt, comparingLong, equals, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Constructor Detail

FixedOrderComparator

@SafeVarargs
public FixedOrderComparator(T... order)

Creates a new FixedOrderComparator with the specified order of terms. The vararg array cannot be null, but member terms can be null.

Parameters:

order - The terms that defined the order.

Throws:

NullPointerException - If order is null.

Method Detail

compare

public int compare(T o1,
                   T o2)

Specified by:

compare in interface Comparator<T extends Comparable<? super T>>