org.apache.commons.collections
public class ComparatorUtils extends java.lang.Object
Comparator
objects.
Most of the utility in this class can also be found in the
comparators
package. This class merely provides a
convenient central place if you have use for more than one class
in the comparators
subpackage.
Note that every method in this class allows you to specify
null
instead of a comparator, in which case
NATURAL_COMPARATOR
will be used.
Modifier and Type | Field and Description |
---|---|
static java.util.Comparator |
NATURAL_COMPARATOR
Comparator for natural sort order.
|
Modifier and Type | Method and Description |
---|---|
static java.util.Comparator |
chainedComparator(java.util.Collection comparators)
Gets a comparator that compares using a collection of
Comparator s. |
static java.util.Comparator |
chainedComparator(java.util.Comparator[] comparators)
Gets a comparator that compares using an array of
Comparator s. |
static java.util.Comparator |
chainedComparator(java.util.Comparator comparator1,
java.util.Comparator comparator2)
Gets a comparator that compares using two
Comparator s. |
static java.lang.Object |
max(java.lang.Object o1,
java.lang.Object o2,
java.util.Comparator comparator)
Returns the smaller of the given objects according to the given
comparator.
|
static java.lang.Object |
min(java.lang.Object o1,
java.lang.Object o2,
java.util.Comparator comparator)
Returns the smaller of the given objects according to the given
comparator.
|
static java.util.Comparator |
naturalComparator()
Gets a comparator that uses the natural order of the objects.
|
static java.util.Comparator |
nullHighComparator(java.util.Comparator comparator)
Gets a Comparator that controls the comparison of
null values. |
static java.util.Comparator |
nullLowComparator(java.util.Comparator comparator)
Gets a Comparator that controls the comparison of
null values. |
static java.util.Comparator |
reversedComparator(java.util.Comparator comparator)
Gets a comparator that reverses the order of the given
comparator.
|
static java.util.Comparator |
transformedComparator(java.util.Comparator comparator,
Transformer transformer)
Gets a Comparator that passes transformed objects to the given comparator.
|
public static final java.util.Comparator NATURAL_COMPARATOR
ComparableComparator.getInstance()
public static java.util.Comparator chainedComparator(java.util.Collection comparators)
Comparator
s.
The second comparator is used if the first comparator returns that equal and so on.
comparators
- the comparators to use, not null or empty or contain nullsjava.lang.NullPointerException
- if comparators collection is null or contains a nulljava.lang.ClassCastException
- if the comparators collection contains the wrong object typepublic static java.util.Comparator chainedComparator(java.util.Comparator[] comparators)
Comparator
s.
The second comparator is used if the first comparator returns that equal and so on.
iterators
- the comparators to use, not null or empty or contain nullsjava.lang.NullPointerException
- if comparators array is null or contains a nullpublic static java.util.Comparator chainedComparator(java.util.Comparator comparator1, java.util.Comparator comparator2)
Comparator
s.
The second comparator is used if the first comparator returns that equal.
comparator1
- the first comparator to use, not nullcomparator2
- the first comparator to use, not nulljava.lang.NullPointerException
- if either comparator is nullpublic static java.lang.Object max(java.lang.Object o1, java.lang.Object o2, java.util.Comparator comparator)
o1
- the first object to compareo2
- the second object to comparecomparator
- the sort order to usepublic static java.lang.Object min(java.lang.Object o1, java.lang.Object o2, java.util.Comparator comparator)
o1
- the first object to compareo2
- the second object to comparecomparator
- the sort order to usepublic static java.util.Comparator naturalComparator()
public static java.util.Comparator nullHighComparator(java.util.Comparator comparator)
null
values.
The returned comparator will consider a null value to be greater than any nonnull value, and equal to any other null value. Two nonnull values will be evaluated with the given comparator.
comparator
- the comparator that wants to allow nullsNullComparator
public static java.util.Comparator nullLowComparator(java.util.Comparator comparator)
null
values.
The returned comparator will consider a null value to be less than any nonnull value, and equal to any other null value. Two nonnull values will be evaluated with the given comparator.
comparator
- the comparator that wants to allow nullsNullComparator
public static java.util.Comparator reversedComparator(java.util.Comparator comparator)
comparator
- the comparator whose order to reverseReverseComparator
public static java.util.Comparator transformedComparator(java.util.Comparator comparator, Transformer transformer)
Objects passed to the returned comparator will first be transformed by the given transformer before they are compared by the given comparator.
comparator
- the sort order to usetransformer
- the transformer to useTransformingComparator
Copyright © 2001-2004 Apache Software Foundation. Documenation generated March 13 2014.