org.springframework.util.comparator

Class BooleanComparator

  • java.lang.Object
    • org.springframework.util.comparator.BooleanComparator
  • All Implemented Interfaces:
    java.io.Serializable, java.util.Comparator<java.lang.Boolean>


    public class BooleanComparator
    extends java.lang.Object
    implements java.util.Comparator<java.lang.Boolean>, java.io.Serializable
    A Comparator for Boolean objects that can sort either true or false first.
    Since:
    1.2.2
    Author:
    Keith Donald
    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static BooleanComparator TRUE_HIGH
      A shared default instance of this comparator, treating true higher than false.
      static BooleanComparator TRUE_LOW
      A shared default instance of this comparator, treating true lower than false.
    • Constructor Summary

      Constructors 
      Constructor and Description
      BooleanComparator(boolean trueLow)
      Create a BooleanComparator that sorts boolean values based on the provided flag.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      int compare(java.lang.Boolean v1, java.lang.Boolean v2) 
      boolean equals(java.lang.Object other) 
      int hashCode() 
      java.lang.String toString() 
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
      • Methods inherited from interface java.util.Comparator

        comparing, comparing, comparingDouble, comparingInt, comparingLong, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong
    • Field Detail

      • TRUE_LOW

        public static final BooleanComparator TRUE_LOW
        A shared default instance of this comparator, treating true lower than false.
      • TRUE_HIGH

        public static final BooleanComparator TRUE_HIGH
        A shared default instance of this comparator, treating true higher than false.
    • Constructor Detail

      • BooleanComparator

        public BooleanComparator(boolean trueLow)
        Create a BooleanComparator that sorts boolean values based on the provided flag.

        Alternatively, you can use the default shared instances: BooleanComparator.TRUE_LOW and BooleanComparator.TRUE_HIGH.

        Parameters:
        trueLow - whether to treat true as lower or higher than false
        See Also:
        TRUE_LOW, TRUE_HIGH
    • Method Detail

      • compare

        public int compare(java.lang.Boolean v1,
                           java.lang.Boolean v2)
        Specified by:
        compare in interface java.util.Comparator<java.lang.Boolean>
      • equals

        public boolean equals(java.lang.Object other)
        Specified by:
        equals in interface java.util.Comparator<java.lang.Boolean>
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object