Package org.opencms.file.collectors

Class CmsPropertyResourceComparator

  • All Implemented Interfaces:
    java.io.Serializable, java.util.Comparator<CmsResource>
    public class CmsPropertyResourceComparator
extends java.lang.Object
implements java.io.Serializable, java.util.Comparator<CmsResource>
    Comparator for sorting resource objects based on a selected property value.

    Serves as Comparator for resources and as comparator key for the resource at the same time. Uses lazy initializing of comparator keys in a resource.

    Since:
    8.0.4
    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      CmsPropertyResourceComparator​(CmsObject cms, java.lang.String property, boolean asc)
      Creates a new instance of this comparator key.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int compare​(CmsResource res0, CmsResource res1)  
      java.lang.String getPropertyValue()
      Returns the property value of this resource comparator key.

      • 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

        equals, reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

    • Constructor Detail

      • CmsPropertyResourceComparator

        public CmsPropertyResourceComparator​(CmsObject cms,
                                     java.lang.String property,
                                     boolean asc)
        Creates a new instance of this comparator key.

        Parameters:
        cms - the current OpenCms user context
        property - the name of the sort property (case sensitive)
        asc - the sort order (true=asc, false=desc)

    • Method Detail

      • compare

        public int compare​(CmsResource res0,
                   CmsResource res1)
        Specified by:
        compare in interface java.util.Comparator<CmsResource>
        See Also:
        Comparator.compare(java.lang.Object, java.lang.Object)

      • getPropertyValue

        public java.lang.String getPropertyValue()
        Returns the property value of this resource comparator key.

        Returns:
        property value of this resource comparator key