com.google.common.collect.AbstractSortedMultiset 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 is a suite of core and expanded libraries that include utility classes, google's collections, io classes, and much much more.
There is a newer version: 33.3.0-jre
Show newest version
/*
 * Copyright (C) 2011 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 static com.google.common.base.Preconditions.checkNotNull;

import com.google.common.annotations.GwtCompatible;
import com.google.j2objc.annotations.WeakOuter;
import java.util.Comparator;
import java.util.Iterator;
import java.util.NavigableSet;
import javax.annotation.CheckForNull;
import org.checkerframework.checker.nullness.qual.Nullable;

/**
 * This class provides a skeletal implementation of the {@link SortedMultiset} interface.
 *
 * The {@link #count} and {@link #size} implementations all iterate across the set returned by
 * {@link Multiset#entrySet()}, as do many methods acting on the set returned by {@link
 * #elementSet()}. Override those methods for better performance.
 *
 * @author Louis Wasserman
 */
@GwtCompatible(emulated = true)
@ElementTypesAreNonnullByDefault
abstract class AbstractSortedMultiset extends AbstractMultiset
    implements SortedMultiset {
  @GwtTransient final Comparator comparator;

  // needed for serialization
  @SuppressWarnings("unchecked")
  AbstractSortedMultiset() {
    this((Comparator) Ordering.natural());
  }

  AbstractSortedMultiset(Comparator comparator) {
    this.comparator = checkNotNull(comparator);
  }

  @Override
  public NavigableSet elementSet() {
    return (NavigableSet) super.elementSet();
  }

  @Override
  NavigableSet createElementSet() {
    return new SortedMultisets.NavigableElementSet(this);
  }

  @Override
  public Comparator comparator() {
    return comparator;
  }

  @Override
  @CheckForNull
  public Entry firstEntry() {
    Iterator> entryIterator = entryIterator();
    return entryIterator.hasNext() ? entryIterator.next() : null;
  }

  @Override
  @CheckForNull
  public Entry lastEntry() {
    Iterator> entryIterator = descendingEntryIterator();
    return entryIterator.hasNext() ? entryIterator.next() : null;
  }

  @Override
  @CheckForNull
  public Entry pollFirstEntry() {
    Iterator> entryIterator = entryIterator();
    if (entryIterator.hasNext()) {
      Entry result = entryIterator.next();
      result = Multisets.immutableEntry(result.getElement(), result.getCount());
      entryIterator.remove();
      return result;
    }
    return null;
  }

  @Override
  @CheckForNull
  public Entry pollLastEntry() {
    Iterator> entryIterator = descendingEntryIterator();
    if (entryIterator.hasNext()) {
      Entry result = entryIterator.next();
      result = Multisets.immutableEntry(result.getElement(), result.getCount());
      entryIterator.remove();
      return result;
    }
    return null;
  }

  @Override
  public SortedMultiset subMultiset(
      @ParametricNullness E fromElement,
      BoundType fromBoundType,
      @ParametricNullness E toElement,
      BoundType toBoundType) {
    // These are checked elsewhere, but NullPointerTester wants them checked eagerly.
    checkNotNull(fromBoundType);
    checkNotNull(toBoundType);
    return tailMultiset(fromElement, fromBoundType).headMultiset(toElement, toBoundType);
  }

  abstract Iterator> descendingEntryIterator();

  Iterator descendingIterator() {
    return Multisets.iteratorImpl(descendingMultiset());
  }

  @CheckForNull private transient SortedMultiset descendingMultiset;

  @Override
  public SortedMultiset descendingMultiset() {
    SortedMultiset result = descendingMultiset;
    return (result == null) ? descendingMultiset = createDescendingMultiset() : result;
  }

  SortedMultiset createDescendingMultiset() {
    @WeakOuter
    class DescendingMultisetImpl extends DescendingMultiset {
      @Override
      SortedMultiset forwardMultiset() {
        return AbstractSortedMultiset.this;
      }

      @Override
      Iterator> entryIterator() {
        return descendingEntryIterator();
      }

      @Override
      public Iterator iterator() {
        return descendingIterator();
      }
    }
    return new DescendingMultisetImpl();
  }
}