edu.mit.jmwe.util

Class CompositeComparator<T>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<java.util.Comparator<T>>

edu.mit.jmwe.util.CompositeComparator<T>

All Implemented Interfaces:

java.lang.Iterable<java.util.Comparator<T>>, java.util.Collection<java.util.Comparator<T>>, java.util.Comparator<T>, java.util.List<java.util.Comparator<T>>

public class CompositeComparator<T>
extends java.util.AbstractList<java.util.Comparator<T>>
implements java.util.Comparator<T>, java.util.List<java.util.Comparator<T>>

A comparator constructed out of multiple comparators.

Since:

jMWE 1.0.0

Version:

$Id: CompositeComparator.java 356 2015-11-25 22:36:46Z markaf $

Author:

M.A. Finlayson

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
CompositeComparator(java.util.Comparator<T>... cs) Constructs a composite comparator from an array of comparators.
CompositeComparator(java.util.Comparator<T> one, java.util.Comparator<T> two) Constructs a composite comparator from two of comparators.
CompositeComparator(java.util.Comparator<T> one, java.util.Comparator<T> two, java.util.Comparator<T> three) Constructs a composite comparator from three of comparators.
CompositeComparator(java.util.List<? extends java.util.Comparator<T>> cs) Constructs a composite comparator from an array of comparators.

Method Summary

Modifier and Type	Method and Description
int	compare(T one, T two)
java.util.Comparator<T>	get(int index)
int	size()

Methods inherited from class java.util.AbstractList

add, add, addAll, clear, equals, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, remove, removeRange, set, subList

Methods inherited from class java.util.AbstractCollection

addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, 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

Methods inherited from interface java.util.List

add, add, addAll, addAll, clear, contains, containsAll, equals, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, replaceAll, retainAll, set, sort, spliterator, subList, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

CompositeComparator

public CompositeComparator(java.util.Comparator<T> one,
                           java.util.Comparator<T> two)

Constructs a composite comparator from two of comparators. The array of comparators should be ordered by descending preference. The most preferred comparator should be first, the second-most-preferred second, etc. The comparators may not be null

Parameters:

one - the first comparator to use, may not be null

two - the second comparator to use, may not be null

Throws:

java.lang.NullPointerException - if any specified comparator null.

Since:

jMWE 1.0.0

CompositeComparator

public CompositeComparator(java.util.Comparator<T> one,
                           java.util.Comparator<T> two,
                           java.util.Comparator<T> three)

Constructs a composite comparator from three of comparators. The array of comparators should be ordered by descending preference. The most preferred comparator should be first, the second-most-preferred second, etc. The comparators may not be null

Parameters:

one - the first comparator to use, may not be null

two - the second comparator to use, may not be null

three - the third comparator to use, may not be null

Throws:

java.lang.NullPointerException - if any specified comparator null.

Since:

jMWE 1.0.0

CompositeComparator

public CompositeComparator(java.util.Comparator<T>... cs)

Constructs a composite comparator from an array of comparators. The array of comparators should be ordered by descending preference. The most preferred comparator should be first, the second-most-preferred second, etc.

Parameters:

cs - the array of comparators in order of descending preference. May not be null, nor contain null.

Throws:

java.lang.NullPointerException - if the specified array is null or if any of its elements are null.

Since:

jMWE 1.0.0

CompositeComparator

public CompositeComparator(java.util.List<? extends java.util.Comparator<T>> cs)

Constructs a composite comparator from an array of comparators. The array of comparators should be ordered by descending preference. The most preferred comparator should be first, the second-most-preferred second, etc.

Parameters:

cs - the list of comparators in order of descending preference. May not be null, nor contain null.

Throws:

java.lang.NullPointerException - if the specified array is null or if any of its elements are null.

Since:

jMWE 1.0.0

Method Detail

compare

public int compare(T one,
                   T two)

Specified by:

compare in interface java.util.Comparator<T>

get

public java.util.Comparator<T> get(int index)

Specified by:

get in interface java.util.List<java.util.Comparator<T>>

Specified by:

get in class java.util.AbstractList<java.util.Comparator<T>>

size

public int size()

Specified by:

size in interface java.util.Collection<java.util.Comparator<T>>

Specified by:

size in interface java.util.List<java.util.Comparator<T>>

Specified by:

size in class java.util.AbstractCollection<java.util.Comparator<T>>