com.google.common.collect.ImmutableMultiset Maven / Gradle / Ivy
Show all versions of guava Show documentation
/*
* Copyright (C) 2008 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.common.annotations.GwtIncompatible;
import com.google.errorprone.annotations.CanIgnoreReturnValue;
import com.google.errorprone.annotations.concurrent.LazyInit;
import com.google.j2objc.annotations.WeakOuter;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collection;
import java.util.Iterator;
import java.util.Set;
import org.checkerframework.checker.nullness.compatqual.MonotonicNonNullDecl;
import org.checkerframework.checker.nullness.compatqual.NullableDecl;
/**
* A {@link Multiset} whose contents will never change, with many other important properties
* detailed at {@link ImmutableCollection}.
*
* Grouped iteration. In all current implementations, duplicate elements always appear
* consecutively when iterating. Elements iterate in order by the first appearance of that
* element when the multiset was created.
*
*
See the Guava User Guide article on immutable collections.
*
* @author Jared Levy
* @author Louis Wasserman
* @since 2.0
*/
@GwtCompatible(serializable = true, emulated = true)
@SuppressWarnings("serial") // we're overriding default serialization
public abstract class ImmutableMultiset extends ImmutableMultisetGwtSerializationDependencies
implements Multiset {
/** Returns the empty immutable multiset. */
@SuppressWarnings("unchecked") // all supported methods are covariant
public static ImmutableMultiset of() {
return (ImmutableMultiset) RegularImmutableMultiset.EMPTY;
}
/**
* Returns an immutable multiset containing a single element.
*
* @throws NullPointerException if {@code element} is null
* @since 6.0 (source-compatible since 2.0)
*/
@SuppressWarnings("unchecked") // generic array created but never written
public static ImmutableMultiset of(E element) {
return copyFromElements(element);
}
/**
* Returns an immutable multiset containing the given elements, in order.
*
* @throws NullPointerException if any element is null
* @since 6.0 (source-compatible since 2.0)
*/
@SuppressWarnings("unchecked") //
public static ImmutableMultiset of(E e1, E e2) {
return copyFromElements(e1, e2);
}
/**
* Returns an immutable multiset containing the given elements, in the "grouped iteration order"
* described in the class documentation.
*
* @throws NullPointerException if any element is null
* @since 6.0 (source-compatible since 2.0)
*/
@SuppressWarnings("unchecked") //
public static ImmutableMultiset of(E e1, E e2, E e3) {
return copyFromElements(e1, e2, e3);
}
/**
* Returns an immutable multiset containing the given elements, in the "grouped iteration order"
* described in the class documentation.
*
* @throws NullPointerException if any element is null
* @since 6.0 (source-compatible since 2.0)
*/
@SuppressWarnings("unchecked") //
public static ImmutableMultiset of(E e1, E e2, E e3, E e4) {
return copyFromElements(e1, e2, e3, e4);
}
/**
* Returns an immutable multiset containing the given elements, in the "grouped iteration order"
* described in the class documentation.
*
* @throws NullPointerException if any element is null
* @since 6.0 (source-compatible since 2.0)
*/
@SuppressWarnings("unchecked") //
public static ImmutableMultiset of(E e1, E e2, E e3, E e4, E e5) {
return copyFromElements(e1, e2, e3, e4, e5);
}
/**
* Returns an immutable multiset containing the given elements, in the "grouped iteration order"
* described in the class documentation.
*
* @throws NullPointerException if any element is null
* @since 6.0 (source-compatible since 2.0)
*/
@SuppressWarnings("unchecked") //
public static ImmutableMultiset of(E e1, E e2, E e3, E e4, E e5, E e6, E... others) {
return new Builder().add(e1).add(e2).add(e3).add(e4).add(e5).add(e6).add(others).build();
}
/**
* Returns an immutable multiset containing the given elements, in the "grouped iteration order"
* described in the class documentation.
*
* @throws NullPointerException if any of {@code elements} is null
* @since 6.0
*/
public static ImmutableMultiset copyOf(E[] elements) {
return copyFromElements(elements);
}
/**
* Returns an immutable multiset containing the given elements, in the "grouped iteration order"
* described in the class documentation.
*
* @throws NullPointerException if any of {@code elements} is null
*/
public static ImmutableMultiset copyOf(Iterable elements) {
if (elements instanceof ImmutableMultiset) {
@SuppressWarnings("unchecked") // all supported methods are covariant
ImmutableMultiset result = (ImmutableMultiset) elements;
if (!result.isPartialView()) {
return result;
}
}
ImmutableMultiset.Builder builder =
new ImmutableMultiset.Builder(Multisets.inferDistinctElements(elements));
builder.addAll(elements);
return builder.build();
}
/**
* Returns an immutable multiset containing the given elements, in the "grouped iteration order"
* described in the class documentation.
*
* @throws NullPointerException if any of {@code elements} is null
*/
public static ImmutableMultiset copyOf(Iterator elements) {
return new ImmutableMultiset.Builder().addAll(elements).build();
}
private static ImmutableMultiset copyFromElements(E... elements) {
return new ImmutableMultiset.Builder().add(elements).build();
}
static ImmutableMultiset copyFromEntries(
Collection> entries) {
ImmutableMultiset.Builder builder = new ImmutableMultiset.Builder(entries.size());
for (Entry entry : entries) {
builder.addCopies(entry.getElement(), entry.getCount());
}
return builder.build();
}
ImmutableMultiset() {}
@Override
public UnmodifiableIterator iterator() {
final Iterator> entryIterator = entrySet().iterator();
return new UnmodifiableIterator() {
int remaining;
@MonotonicNonNullDecl E element;
@Override
public boolean hasNext() {
return (remaining > 0) || entryIterator.hasNext();
}
@Override
public E next() {
if (remaining <= 0) {
Entry entry = entryIterator.next();
element = entry.getElement();
remaining = entry.getCount();
}
remaining--;
return element;
}
};
}
@LazyInit private transient ImmutableList asList;
@Override
public ImmutableList asList() {
ImmutableList result = asList;
return (result == null) ? asList = super.asList() : result;
}
@Override
public boolean contains(@NullableDecl Object object) {
return count(object) > 0;
}
/**
* Guaranteed to throw an exception and leave the collection unmodified.
*
* @throws UnsupportedOperationException always
* @deprecated Unsupported operation.
*/
@CanIgnoreReturnValue
@Deprecated
@Override
public final int add(E element, int occurrences) {
throw new UnsupportedOperationException();
}
/**
* Guaranteed to throw an exception and leave the collection unmodified.
*
* @throws UnsupportedOperationException always
* @deprecated Unsupported operation.
*/
@CanIgnoreReturnValue
@Deprecated
@Override
public final int remove(Object element, int occurrences) {
throw new UnsupportedOperationException();
}
/**
* Guaranteed to throw an exception and leave the collection unmodified.
*
* @throws UnsupportedOperationException always
* @deprecated Unsupported operation.
*/
@CanIgnoreReturnValue
@Deprecated
@Override
public final int setCount(E element, int count) {
throw new UnsupportedOperationException();
}
/**
* Guaranteed to throw an exception and leave the collection unmodified.
*
* @throws UnsupportedOperationException always
* @deprecated Unsupported operation.
*/
@CanIgnoreReturnValue
@Deprecated
@Override
public final boolean setCount(E element, int oldCount, int newCount) {
throw new UnsupportedOperationException();
}
@GwtIncompatible // not present in emulated superclass
@Override
int copyIntoArray(Object[] dst, int offset) {
for (Multiset.Entry entry : entrySet()) {
Arrays.fill(dst, offset, offset + entry.getCount(), entry.getElement());
offset += entry.getCount();
}
return offset;
}
@Override
public boolean equals(@NullableDecl Object object) {
return Multisets.equalsImpl(this, object);
}
@Override
public int hashCode() {
return Sets.hashCodeImpl(entrySet());
}
@Override
public String toString() {
return entrySet().toString();
}
/** @since 21.0 (present with return type {@code Set} since 2.0) */
@Override
public abstract ImmutableSet elementSet();
@LazyInit private transient ImmutableSet> entrySet;
@Override
public ImmutableSet> entrySet() {
ImmutableSet> es = entrySet;
return (es == null) ? (entrySet = createEntrySet()) : es;
}
private ImmutableSet> createEntrySet() {
return isEmpty() ? ImmutableSet.>of() : new EntrySet();
}
abstract Entry getEntry(int index);
@WeakOuter
private final class EntrySet extends IndexedImmutableSet> {
@Override
boolean isPartialView() {
return ImmutableMultiset.this.isPartialView();
}
@Override
Entry get(int index) {
return getEntry(index);
}
@Override
public int size() {
return elementSet().size();
}
@Override
public boolean contains(Object o) {
if (o instanceof Entry) {
Entry entry = (Entry) o;
if (entry.getCount() <= 0) {
return false;
}
int count = count(entry.getElement());
return count == entry.getCount();
}
return false;
}
@Override
public int hashCode() {
return ImmutableMultiset.this.hashCode();
}
@GwtIncompatible
@Override
Object writeReplace() {
return new EntrySetSerializedForm(ImmutableMultiset.this);
}
private static final long serialVersionUID = 0;
}
@GwtIncompatible
static class EntrySetSerializedForm implements Serializable {
final ImmutableMultiset multiset;
EntrySetSerializedForm(ImmutableMultiset multiset) {
this.multiset = multiset;
}
Object readResolve() {
return multiset.entrySet();
}
}
@GwtIncompatible
@Override
abstract Object writeReplace();
/**
* Returns a new builder. The generated builder is equivalent to the builder created by the {@link
* Builder} constructor.
*/
public static Builder builder() {
return new Builder();
}
/**
* A builder for creating immutable multiset instances, especially {@code public static final}
* multisets ("constant multisets"). Example:
*
* {@code
* public static final ImmutableMultiset BEANS =
* new ImmutableMultiset.Builder()
* .addCopies(Bean.COCOA, 4)
* .addCopies(Bean.GARDEN, 6)
* .addCopies(Bean.RED, 8)
* .addCopies(Bean.BLACK_EYED, 10)
* .build();
* }
*
* Builder instances can be reused; it is safe to call {@link #build} multiple times to build
* multiple multisets in series.
*
* @since 2.0
*/
public static class Builder extends ImmutableCollection.Builder {
ObjectCountHashMap contents;
/**
* If build() has been called on the current contents multiset, we need to copy it on any future
* modifications, or we'll modify the already-built ImmutableMultiset.
*/
boolean buildInvoked = false;
/**
* In the event of a setCount(elem, 0) call, we may need to remove elements, which destroys the
* insertion order property of ObjectCountHashMap. In that event, we need to convert to a
* ObjectCountLinkedHashMap, but we need to know we did that so we can convert back.
*/
boolean isLinkedHash = false;
/**
* Creates a new builder. The returned builder is equivalent to the builder generated by {@link
* ImmutableMultiset#builder}.
*/
public Builder() {
this(4);
}
Builder(int estimatedDistinct) {
this.contents = ObjectCountHashMap.createWithExpectedSize(estimatedDistinct);
}
Builder(boolean forSubtype) {
// for ImmutableSortedMultiset not to allocate data structures not used there
this.contents = null;
}
/**
* Adds {@code element} to the {@code ImmutableMultiset}.
*
* @param element the element to add
* @return this {@code Builder} object
* @throws NullPointerException if {@code element} is null
*/
@CanIgnoreReturnValue
@Override
public Builder add(E element) {
return addCopies(element, 1);
}
/**
* Adds each element of {@code elements} to the {@code ImmutableMultiset}.
*
* @param elements the elements to add
* @return this {@code Builder} object
* @throws NullPointerException if {@code elements} is null or contains a null element
*/
@CanIgnoreReturnValue
@Override
public Builder add(E... elements) {
super.add(elements);
return this;
}
/**
* Adds a number of occurrences of an element to this {@code ImmutableMultiset}.
*
* @param element the element to add
* @param occurrences the number of occurrences of the element to add. May be zero, in which
* case no change will be made.
* @return this {@code Builder} object
* @throws NullPointerException if {@code element} is null
* @throws IllegalArgumentException if {@code occurrences} is negative, or if this operation
* would result in more than {@link Integer#MAX_VALUE} occurrences of the element
*/
@CanIgnoreReturnValue
public Builder addCopies(E element, int occurrences) {
if (occurrences == 0) {
return this;
}
if (buildInvoked) {
contents = new ObjectCountHashMap(contents);
isLinkedHash = false;
}
buildInvoked = false;
checkNotNull(element);
contents.put(element, occurrences + contents.get(element));
return this;
}
/**
* Adds or removes the necessary occurrences of an element such that the element attains the
* desired count.
*
* @param element the element to add or remove occurrences of
* @param count the desired count of the element in this multiset
* @return this {@code Builder} object
* @throws NullPointerException if {@code element} is null
* @throws IllegalArgumentException if {@code count} is negative
*/
@CanIgnoreReturnValue
public Builder setCount(E element, int count) {
if (count == 0 && !isLinkedHash) {
contents = new ObjectCountLinkedHashMap(contents);
isLinkedHash = true;
// to preserve insertion order through deletions, we have to switch to an actual linked
// implementation at least for now, but this should be a super rare case
} else if (buildInvoked) {
contents = new ObjectCountHashMap(contents);
isLinkedHash = false;
}
buildInvoked = false;
checkNotNull(element);
if (count == 0) {
contents.remove(element);
} else {
contents.put(checkNotNull(element), count);
}
return this;
}
/**
* Adds each element of {@code elements} to the {@code ImmutableMultiset}.
*
* @param elements the {@code Iterable} to add to the {@code ImmutableMultiset}
* @return this {@code Builder} object
* @throws NullPointerException if {@code elements} is null or contains a null element
*/
@CanIgnoreReturnValue
@Override
public Builder addAll(Iterable elements) {
if (elements instanceof Multiset) {
Multiset multiset = Multisets.cast(elements);
ObjectCountHashMap backingMap = tryGetMap(multiset);
if (backingMap != null) {
contents.ensureCapacity(Math.max(contents.size(), backingMap.size()));
for (int i = backingMap.firstIndex(); i >= 0; i = backingMap.nextIndex(i)) {
addCopies(backingMap.getKey(i), backingMap.getValue(i));
}
} else {
Set> entries = multiset.entrySet();
contents.ensureCapacity(Math.max(contents.size(), entries.size())); // might overlap
for (Entry entry : multiset.entrySet()) {
addCopies(entry.getElement(), entry.getCount());
}
}
} else {
super.addAll(elements);
}
return this;
}
/**
* Adds each element of {@code elements} to the {@code ImmutableMultiset}.
*
* @param elements the elements to add to the {@code ImmutableMultiset}
* @return this {@code Builder} object
* @throws NullPointerException if {@code elements} is null or contains a null element
*/
@CanIgnoreReturnValue
@Override
public Builder addAll(Iterator elements) {
super.addAll(elements);
return this;
}
/**
* If the specified collection is backed by an ObjectCountHashMap, it will be much more
* efficient to iterate over it by index rather than an entry iterator, which will need to
* allocate an object for each entry, so we check for that.
*/
@NullableDecl
static ObjectCountHashMap tryGetMap(Iterable multiset) {
if (multiset instanceof RegularImmutableMultiset) {
return ((RegularImmutableMultiset) multiset).contents;
} else if (multiset instanceof AbstractMapBasedMultiset) {
return ((AbstractMapBasedMultiset) multiset).backingMap;
} else {
return null;
}
}
/**
* Returns a newly-created {@code ImmutableMultiset} based on the contents of the {@code
* Builder}.
*/
@Override
public ImmutableMultiset build() {
if (contents.size() == 0) {
return of();
}
if (isLinkedHash) {
// we need ObjectCountHashMap-backed contents, with its keys and values array in direct
// insertion order
contents = new ObjectCountHashMap(contents);
isLinkedHash = false;
}
buildInvoked = true;
// contents is now ObjectCountHashMap, but still guaranteed to be in insertion order!
return new RegularImmutableMultiset(contents);
}
}
}