com.google.common.collect.CompoundOrdering Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of guava Show documentation

Guava library, with additional type annotations

There is a newer version: 33.1.0.2-jre

/*
 * Copyright (C) 2007 The Guava Authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.google.common.collect;

import org.checkerframework.dataflow.qual.Pure;
import org.checkerframework.framework.qual.AnnotatedFor;

import com.google.common.annotations.GwtCompatible;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Comparator;

/** An ordering that tries several comparators in order. */
@AnnotatedFor({"nullness"})
@GwtCompatible(serializable = true)
final class CompoundOrdering extends Ordering implements Serializable {
  final Comparator[] comparators;

  CompoundOrdering(Comparator primary, Comparator secondary) {
    this.comparators = (Comparator[]) new Comparator[] {primary, secondary};
  }

  CompoundOrdering(Iterable> comparators) {
    this.comparators = Iterables.toArray(comparators, new Comparator[0]);
  }

  @Pure
  @Override
  public int compare(T left, T right) {
    for (int i = 0; i < comparators.length; i++) {
      int result = comparators[i].compare(left, right);
      if (result != 0) {
        return result;
      }
    }
    return 0;
  }

  @Pure
  @Override
  public boolean equals(@org.checkerframework.checker.nullness.qual.Nullable Object object) {
    if (object == this) {
      return true;
    }
    if (object instanceof CompoundOrdering) {
      CompoundOrdering that = (CompoundOrdering) object;
      return Arrays.equals(this.comparators, that.comparators);
    }
    return false;
  }

  @Pure
  @Override
  public int hashCode() {
    return Arrays.hashCode(comparators);
  }

  @Pure
  @Override
  public String toString() {
    return "Ordering.compound(" + Arrays.toString(comparators) + ")";
  }

  private static final long serialVersionUID = 0;
}