Package com.google.common.collect

Class ComparisonChain

java.lang.Object
com.google.common.collect.ComparisonChain
@GwtCompatible @Deprecated(since="2022-12-01") public abstract class ComparisonChain extends Object
Deprecated.
The Google Guava Core Libraries are deprecated and will not be part of the AEM SDK after April 2023
A utility for performing a chained comparison statement. For example: 
   

    public int compareTo(Foo that) {
      return ComparisonChain.start()
          .compare(this.aString, that.aString)
          .compare(this.anInt, that.anInt)
          .compare(this.anEnum, that.anEnum, Ordering.natural().nullsLast())
          .result();
    }

The value of this expression will have the same sign as the first nonzero comparison result in the chain, or will be zero if every comparison result was zero.

Performance note: Even though the ComparisonChain caller always invokes its compare methods unconditionally, the ComparisonChain implementation stops calling its inputs' compareTo and compare methods as soon as one of them returns a nonzero result. This optimization is typically important only in the presence of expensive compareTo and compare implementations.

See the Guava User Guide article on ComparisonChain.

Since:
2.0

  • Method Details

    • start

      public static ComparisonChain start()
      Deprecated.
      Begins a new chained comparison statement. See example in the class documentation.

    • compare

      public abstract ComparisonChain compare(Comparable<?> left, Comparable<?> right)
      Deprecated.
      Compares two comparable objects as specified by Comparable.compareTo(T), if the result of this comparison chain has not already been determined.

    • compare

      public abstract <T> ComparisonChain compare(@Nullable T left, @Nullable T right, Comparator<T> comparator)
      Deprecated.
      Compares two objects using a comparator, if the result of this comparison chain has not already been determined.

    • compare

      public abstract ComparisonChain compare(int left, int right)
      Deprecated.
      Compares two int values as specified by Ints.compare(int, int), if the result of this comparison chain has not already been determined.

    • compare

      public abstract ComparisonChain compare(long left, long right)
      Deprecated.
      Compares two long values as specified by Longs.compare(long, long), if the result of this comparison chain has not already been determined.

    • compare

      public abstract ComparisonChain compare(float left, float right)
      Deprecated.
      Compares two float values as specified by Float.compare(float, float), if the result of this comparison chain has not already been determined.

    • compare

      public abstract ComparisonChain compare(double left, double right)
      Deprecated.
      Compares two double values as specified by Double.compare(double, double), if the result of this comparison chain has not already been determined.

    • compareTrueFirst

      public abstract ComparisonChain compareTrueFirst(boolean left, boolean right)
      Deprecated.
      Compares two boolean values, considering true to be less than false, if the result of this comparison chain has not already been determined.
      Since:
      12.0

    • compareFalseFirst

      public abstract ComparisonChain compareFalseFirst(boolean left, boolean right)
      Deprecated.
      Compares two boolean values, considering false to be less than true, if the result of this comparison chain has not already been determined.
      Since:
      12.0 (present as compare since 2.0)

    • compare

      @Deprecated public final ComparisonChain compare(boolean left, boolean right)
      Deprecated.
      Use compareFalseFirst(boolean, boolean); or, if the parameters passed are being either negated or reversed, undo the negation or reversal and use compareTrueFirst(boolean, boolean). This method is scheduled for deletion in September 2013.
      Old name of compareFalseFirst(boolean, boolean).

    • result

      public abstract int result()
      Deprecated.
      Ends this comparison chain and returns its result: a value having the same sign as the first nonzero comparison result in the chain, or zero if every result was zero.