Save This Page
Home » commons-collections-3.2.1-src » org.apache.commons » collections » [javadoc | source]
org.apache.commons.collections
public class: ComparatorUtils [javadoc | source]
java.lang.Object
   org.apache.commons.collections.ComparatorUtils
Provides convenient static utility methods for Comparator objects.

Most of the functionality 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.

Field Summary
public static final  Comparator NATURAL_COMPARATOR    Comparator for natural sort order.
    Also see:
    ComparableComparator#getInstance
 
Constructor:
 public ComparatorUtils() 
Method from org.apache.commons.collections.ComparatorUtils Summary:
booleanComparator,   chainedComparator,   chainedComparator,   chainedComparator,   max,   min,   naturalComparator,   nullHighComparator,   nullLowComparator,   reversedComparator,   transformedComparator
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.commons.collections.ComparatorUtils Detail:
 public static Comparator booleanComparator(boolean trueFirst) 
    Gets a Comparator that can sort Boolean objects.

    The parameter specifies whether true or false is sorted first.

    The comparator throws NullPointerException if a null value is compared.

 public static Comparator chainedComparator(Comparator[] comparators) 
    Gets a comparator that compares using an array of Comparator s, applied in sequence until one returns not equal or the array is exhausted.
 public static Comparator chainedComparator(Collection comparators) 
    Gets a comparator that compares using a collection of Comparator s, applied in (default iterator) sequence until one returns not equal or the collection is exhausted.
 public static Comparator chainedComparator(Comparator comparator1,
    Comparator comparator2) 
    Gets a comparator that compares using two Comparator s.

    The second comparator is used if the first comparator returns equal.

 public static Object max(Object o1,
    Object o2,
    Comparator comparator) 
    Returns the larger of the given objects according to the given comparator, returning the second object if the comparator returns equal.
 public static Object min(Object o1,
    Object o2,
    Comparator comparator) 
    Returns the smaller of the given objects according to the given comparator, returning the second object if the comparator returns equal.
 public static Comparator naturalComparator() 
    Gets a comparator that uses the natural order of the objects.
 public static Comparator nullHighComparator(Comparator comparator) 
    Gets a Comparator that controls the comparison of 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.

 public static Comparator nullLowComparator(Comparator comparator) 
    Gets a Comparator that controls the comparison of 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.

 public static Comparator reversedComparator(Comparator comparator) 
    Gets a comparator that reverses the order of the given comparator.
 public static Comparator transformedComparator(Comparator comparator,
    Transformer transformer) 
    Gets a Comparator that passes transformed objects to the given comparator.

    Objects passed to the returned comparator will first be transformed by the given transformer before they are compared by the given comparator.