org.springframework.beans.support

Class PropertyComparator<T>

  • java.lang.Object
    • org.springframework.beans.support.PropertyComparator<T>
  • Type Parameters:
    T - the type of objects that may be compared by this comparator
    All Implemented Interfaces:
    java.util.Comparator<T>


    public class PropertyComparator<T>
    extends java.lang.Object
    implements java.util.Comparator<T>
    PropertyComparator performs a comparison of two beans, evaluating the specified bean property via a BeanWrapper.
    Since:
    19.05.2003
    Author:
    Juergen Hoeller, Jean-Pierre Pawlak
    See Also:
    BeanWrapper
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      protected Log logger 
    • Constructor Summary

      Constructors 
      Constructor and Description
      PropertyComparator(SortDefinition sortDefinition)
      Create a new PropertyComparator for the given SortDefinition.
      PropertyComparator(java.lang.String property, boolean ignoreCase, boolean ascending)
      Create a PropertyComparator for the given settings.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      int compare(T o1, T o2) 
      SortDefinition getSortDefinition()
      Return the SortDefinition that this comparator uses.
      static void sort(java.util.List<?> source, SortDefinition sortDefinition)
      Sort the given List according to the given sort definition.
      static void sort(java.lang.Object[] source, SortDefinition sortDefinition)
      Sort the given source according to the given sort definition.
      • 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
    • Field Detail

      • logger

        protected final Log logger
    • Constructor Detail

      • PropertyComparator

        public PropertyComparator(java.lang.String property,
                                  boolean ignoreCase,
                                  boolean ascending)
        Create a PropertyComparator for the given settings.
        Parameters:
        property - the property to compare
        ignoreCase - whether upper and lower case in String values should be ignored
        ascending - whether to sort ascending (true) or descending (false)
    • Method Detail

      • getSortDefinition

        public final SortDefinition getSortDefinition()
        Return the SortDefinition that this comparator uses.
      • compare

        public int compare(T o1,
                           T o2)
        Specified by:
        compare in interface java.util.Comparator<T>
      • sort

        public static void sort(java.util.List<?> source,
                                SortDefinition sortDefinition)
                         throws BeansException
        Sort the given List according to the given sort definition.

        Note: Contained objects have to provide the given property in the form of a bean property, i.e. a getXXX method.

        Parameters:
        source - the input List
        sortDefinition - the parameters to sort by
        Throws:
        java.lang.IllegalArgumentException - in case of a missing propertyName
        BeansException
      • sort

        public static void sort(java.lang.Object[] source,
                                SortDefinition sortDefinition)
                         throws BeansException
        Sort the given source according to the given sort definition.

        Note: Contained objects have to provide the given property in the form of a bean property, i.e. a getXXX method.

        Parameters:
        source - input source
        sortDefinition - the parameters to sort by
        Throws:
        java.lang.IllegalArgumentException - in case of a missing propertyName
        BeansException