Class RegularImmutableSortedMultiset<E>

All Implemented Interfaces:
Multiset<E>, SortedIterable<E>, SortedMultiset<E>, SortedMultisetBridge<E>, Serializable, Iterable<E>, Collection<E>

final class RegularImmutableSortedMultiset<E> extends ImmutableSortedMultiset<E>
An immutable sorted multiset with one or more distinct elements.
  • Field Details

    • ZERO_CUMULATIVE_COUNTS

      private static final long[] ZERO_CUMULATIVE_COUNTS
    • NATURAL_EMPTY_MULTISET

      static final ImmutableSortedMultiset<?> NATURAL_EMPTY_MULTISET
    • elementSet

      final transient RegularImmutableSortedSet<E> elementSet
    • cumulativeCounts

      private final transient long[] cumulativeCounts
    • offset

      private final transient int offset
    • length

      private final transient int length
  • Constructor Details

    • RegularImmutableSortedMultiset

      RegularImmutableSortedMultiset(Comparator<? super E> comparator)
    • RegularImmutableSortedMultiset

      RegularImmutableSortedMultiset(RegularImmutableSortedSet<E> elementSet, long[] cumulativeCounts, int offset, int length)
  • Method Details

    • getCount

      private int getCount(int index)
    • getEntry

      Multiset.Entry<E> getEntry(int index)
      Specified by:
      getEntry in class ImmutableMultiset<E>
    • forEachEntry

      public void forEachEntry(ObjIntConsumer<? super E> action)
      Description copied from interface: Multiset
      Runs the specified action for each distinct element in this multiset, and the number of occurrences of that element. For some Multiset implementations, this may be more efficient than iterating over the Multiset.entrySet() either explicitly or with entrySet().forEach(action).
    • 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.
    • 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.
    • count

      public int count(@CheckForNull Object element)
      Description copied from interface: Multiset
      Returns the number of occurrences of an element in this multiset (the count of the element). Note that for an Object.equals(java.lang.Object)-based multiset, this gives the same result as Collections.frequency(java.util.Collection<?>, java.lang.Object) (which would presumably perform more poorly).

      Note: the utility method Iterables.frequency(java.lang.Iterable<?>, java.lang.Object) generalizes this operation; it correctly delegates to this method when dealing with a multiset, but it can also accept any other iterable type.

      Parameters:
      element - the element to count occurrences of
      Returns:
      the number of occurrences of the element in this multiset; possibly zero but never negative
    • size

      public int size()
      Description copied from interface: Multiset
      Returns the total number of all occurrences of all elements in this multiset.

      Note: this method does not return the number of distinct elements in the multiset, which is given by entrySet().size().

      Specified by:
      size in interface Collection<E>
      Specified by:
      size in interface Multiset<E>
      Specified by:
      size in class AbstractCollection<E>
    • elementSet

      public ImmutableSortedSet<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>
      Specified by:
      elementSet in class ImmutableSortedMultiset<E>
      Returns:
      a view of the set of distinct elements in this multiset
    • headMultiset

      public ImmutableSortedMultiset<E> headMultiset(E upperBound, BoundType boundType)
      Description copied from interface: SortedMultiset
      Returns a view of this multiset restricted to the elements less than upperBound, optionally including upperBound itself. 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.

      Specified by:
      headMultiset in interface SortedMultiset<E>
      Specified by:
      headMultiset in class ImmutableSortedMultiset<E>
    • tailMultiset

      public ImmutableSortedMultiset<E> tailMultiset(E lowerBound, BoundType boundType)
      Description copied from interface: SortedMultiset
      Returns a view of this multiset restricted to the elements greater than lowerBound, optionally including lowerBound itself. 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.

      Specified by:
      tailMultiset in interface SortedMultiset<E>
      Specified by:
      tailMultiset in class ImmutableSortedMultiset<E>
    • getSubMultiset

      ImmutableSortedMultiset<E> getSubMultiset(int from, int to)
    • isPartialView

      boolean isPartialView()
      Description copied from class: ImmutableCollection
      Returns true if this immutable collection's implementation contains references to user-created objects that aren't accessible via this collection's methods. This is generally used to determine whether copyOf implementations should make an explicit copy to avoid memory leaks.
      Specified by:
      isPartialView in class ImmutableCollection<E>
    • writeReplace

      Object writeReplace()
      Overrides:
      writeReplace in class ImmutableSortedMultiset<E>