Package org.apache.commons.collections.comparators

Class TransformingComparator

java.lang.Object
org.apache.commons.collections.comparators.TransformingComparator
All Implemented Interfaces:
Comparator
public class TransformingComparator extends Object implements Comparator
Decorates another Comparator with transformation behavior. That is, the return value from the transform operation will be passed to the decorated compare method.
Since:
Commons Collections 2.0 (?)
Version:
$Revision: 646777 $ $Date: 2008-04-10 14:33:15 +0200 (Thu, 10 Apr 2008) $
See Also:

  • Field Details

    • decorated

      protected Comparator decorated
      The decorated comparator.

    • transformer

      protected Transformer transformer
      The transformer being used.

  • Constructor Details

    • TransformingComparator

      public TransformingComparator(Transformer transformer)
      Constructs an instance with the given Transformer and a ComparableComparator.
      Parameters:
      transformer - what will transform the arguments to compare

    • TransformingComparator

      public TransformingComparator(Transformer transformer, Comparator decorated)
      Constructs an instance with the given Transformer and Comparator.
      Parameters:
      transformer - what will transform the arguments to compare
      decorated - the decorated Comparator

  • Method Details

    • compare

      public int compare(Object obj1, Object obj2)
      Returns the result of comparing the values from the transform operation.
      Specified by:
      compare in interface Comparator
      Parameters:
      obj1 - the first object to transform then compare
      obj2 - the second object to transform then compare
      Returns:
      negative if obj1 is less, positive if greater, zero if equal