Class AbstractSortedMultiset<E>

java.lang.Object
java.util.AbstractCollection<E>
com.google.common.collect.AbstractMultiset<E>
com.google.common.collect.AbstractSortedMultiset<E>
All Implemented Interfaces:
Multiset<E>, SortedIterable<E>, SortedMultiset<E>, SortedMultisetBridge<E>, Iterable<E>, Collection<E>
Direct Known Subclasses:
TreeMultiset

abstract class AbstractSortedMultiset<E> extends AbstractMultiset<E> implements SortedMultiset<E>
This class provides a skeletal implementation of the SortedMultiset interface.

The Multiset.count(java.lang.Object) and AbstractCollection.size() implementations all iterate across the set returned by Multiset.entrySet(), as do many methods acting on the set returned by elementSet(). Override those methods for better performance.

  • Field Details

  • Constructor Details

    • AbstractSortedMultiset

      AbstractSortedMultiset()
    • AbstractSortedMultiset

      AbstractSortedMultiset(Comparator<? super E> comparator)
  • Method Details

    • elementSet

      public NavigableSet<E> elementSet()
      Description copied from interface: Multiset
      Returns the set of distinct elements contained in this multiset. The element set is backed by the same data as the multiset, so any change to either is immediately reflected in the other. The order of the elements in the element set is unspecified.

      If the element set supports any removal operations, these necessarily cause all occurrences of the removed element(s) to be removed from the multiset. Implementations are not expected to support the add operations, although this is possible.

      A common use for the element set is to find the number of distinct elements in the multiset: elementSet().size().

      Specified by:
      elementSet in interface Multiset<E>
      Specified by:
      elementSet in interface SortedMultiset<E>
      Specified by:
      elementSet in interface SortedMultisetBridge<E>
      Overrides:
      elementSet in class AbstractMultiset<E>
      Returns:
      a view of the set of distinct elements in this multiset
    • createElementSet

      NavigableSet<E> createElementSet()
      Description copied from class: AbstractMultiset
      Creates a new instance of this multiset's element set, which will be returned by AbstractMultiset.elementSet().
      Overrides:
      createElementSet in class AbstractMultiset<E>
    • comparator

      public Comparator<? super E> comparator()
      Description copied from interface: SortedMultiset
      Returns the comparator that orders this multiset, or Ordering.natural() if the natural ordering of the elements is used.
      Specified by:
      comparator in interface SortedIterable<E>
      Specified by:
      comparator in interface SortedMultiset<E>
    • firstEntry

      @CheckForNull public Multiset.Entry<E> firstEntry()
      Description copied from interface: SortedMultiset
      Returns the entry of the first element in this multiset, or null if this multiset is empty.
      Specified by:
      firstEntry in interface SortedMultiset<E>
    • lastEntry

      @CheckForNull public Multiset.Entry<E> lastEntry()
      Description copied from interface: SortedMultiset
      Returns the entry of the last element in this multiset, or null if this multiset is empty.
      Specified by:
      lastEntry in interface SortedMultiset<E>
    • pollFirstEntry

      @CheckForNull public Multiset.Entry<E> pollFirstEntry()
      Description copied from interface: SortedMultiset
      Returns and removes the entry associated with the lowest element in this multiset, or returns null if this multiset is empty.
      Specified by:
      pollFirstEntry in interface SortedMultiset<E>
    • pollLastEntry

      @CheckForNull public Multiset.Entry<E> pollLastEntry()
      Description copied from interface: SortedMultiset
      Returns and removes the entry associated with the greatest element in this multiset, or returns null if this multiset is empty.
      Specified by:
      pollLastEntry in interface SortedMultiset<E>
    • subMultiset

      public SortedMultiset<E> subMultiset(E fromElement, BoundType fromBoundType, E toElement, BoundType toBoundType)
      Description copied from interface: SortedMultiset
      Returns a view of this multiset restricted to the range between lowerBound and upperBound. The returned multiset is a view of this multiset, so changes to one will be reflected in the other. The returned multiset supports all operations that this multiset supports.

      The returned multiset will throw an IllegalArgumentException on attempts to add elements outside its range.

      This method is equivalent to tailMultiset(lowerBound, lowerBoundType).headMultiset(upperBound, upperBoundType).

      Specified by:
      subMultiset in interface SortedMultiset<E>
    • descendingEntryIterator

      abstract Iterator<Multiset.Entry<E>> descendingEntryIterator()
    • descendingIterator

      Iterator<E> descendingIterator()
    • descendingMultiset

      public SortedMultiset<E> descendingMultiset()
      Description copied from interface: SortedMultiset
      Returns a descending view of this multiset. Modifications made to either map will be reflected in the other.
      Specified by:
      descendingMultiset in interface SortedMultiset<E>
    • createDescendingMultiset

      SortedMultiset<E> createDescendingMultiset()