com.google.common.collect.AbstractMultiset Maven / Gradle / Ivy
Show all versions of google-collections Show documentation
/*
* Copyright (C) 2007 Google Inc.
*
* 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 com.google.common.annotations.GwtCompatible;
import com.google.common.base.Objects;
import static com.google.common.base.Preconditions.checkNotNull;
import static com.google.common.base.Preconditions.checkState;
import static com.google.common.collect.Multisets.setCountImpl;
import java.util.AbstractCollection;
import java.util.AbstractSet;
import java.util.Collection;
import java.util.Iterator;
import java.util.List;
import java.util.NoSuchElementException;
import java.util.Set;
import javax.annotation.Nullable;
/**
* This class provides a skeletal implementation of the {@link Multiset}
* interface. A new multiset implementation can be created easily by extending
* this class and implementing the {@link Multiset#entrySet()} method, plus
* optionally overriding {@link #add(Object, int)} and
* {@link #remove(Object, int)} to enable modifications to the multiset.
*
* The {@link #contains}, {@link #containsAll}, {@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 Kevin Bourrillion
*/
@GwtCompatible
abstract class AbstractMultiset extends AbstractCollection
implements Multiset {
public abstract Set> entrySet();
// Query Operations
/**
* {@inheritDoc}
*
* This implementation iterates across {@link Multiset#entrySet()} and
* sums the counts of the entries.
*/
@Override public int size() {
long sum = 0L;
for (Entry entry : entrySet()) {
sum += entry.getCount();
}
return (int) Math.min(sum, Integer.MAX_VALUE);
}
@Override public boolean isEmpty() {
return entrySet().isEmpty();
}
/**
* Returns {@code true} if this collection contains the specified element.
*
* This implementation checks whether {@link #elementSet} contains the
* element.
*/
@Override public boolean contains(@Nullable Object element) {
return elementSet().contains(element);
}
/**
* {@inheritDoc}
*
*
This implementation usually invokes methods of the
* {@link Multiset#entrySet()} iterator. However, the iterator's
* {@code remove} method sometimes calls the multiset's {@code remove}.
*/
@Override public Iterator iterator() {
return new MultisetIterator();
}
private class MultisetIterator implements Iterator {
private final Iterator> entryIterator;
private Entry currentEntry;
/** Count of subsequent elements equal to current element */
private int laterCount;
/** Count of all elements equal to current element */
private int totalCount;
private boolean canRemove;
MultisetIterator() {
this.entryIterator = entrySet().iterator();
}
public boolean hasNext() {
return laterCount > 0 || entryIterator.hasNext();
}
public E next() {
if (!hasNext()) {
throw new NoSuchElementException();
}
if (laterCount == 0) {
currentEntry = entryIterator.next();
totalCount = laterCount = currentEntry.getCount();
}
laterCount--;
canRemove = true;
return currentEntry.getElement();
}
public void remove() {
checkState(canRemove,
"no calls to next() since the last call to remove()");
if (totalCount == 1) {
entryIterator.remove();
} else {
AbstractMultiset.this.remove(currentEntry.getElement());
}
totalCount--;
canRemove = false;
}
}
/**
* {@inheritDoc}
*
* This implementation iterates across {@link Multiset#entrySet()} and
* sums the count of all entries.
*/
public int count(Object element) {
for (Entry entry : entrySet()) {
if (Objects.equal(entry.getElement(), element)) {
return entry.getCount();
}
}
return 0;
}
// Modification Operations
/**
* Ensures that this collection contains the specified element.
*
* This implementation calls {@link #add(Object, int)} with one occurrence.
*
* @return {@code true} always
*/
@Override public boolean add(@Nullable E element) {
add(element, 1);
return true;
}
/**
* {@inheritDoc}
*
*
This implementation always throws an
* {@link UnsupportedOperationException}. To support adding elements, override
* it.
*/
public int add(E element, int occurrences) {
throw new UnsupportedOperationException();
}
/**
* Removes a single instance of the specified element from this collection, if
* it is present.
*
*
This implementation calls {@link #remove(Object, int)} with 1
* occurrence.
*/
@Override public boolean remove(Object element) {
return remove(element, 1) > 0;
}
/**
* {@inheritDoc}
*
*
This implementation always throws an
* {@link UnsupportedOperationException}. To support removing elements,
* override it.
*/
public int remove(Object element, int occurrences) {
throw new UnsupportedOperationException();
}
/**
* {@inheritDoc}
*
*
This implementation compares the current count for the given element to
* its requested count and, if they do not match, calls
* {@link #add(Object, int)} or {@link #remove(Object, int)} to make the
* appropriate adjustment.
*/
public int setCount(E element, int count) {
return setCountImpl(this, element, count);
}
/**
* {@inheritDoc}
*
*
This implementation compares {@code oldCount} to the current count and
* calls {@link #setCount(Object, int)} if they match.
*/
public boolean setCount(E element, int oldCount, int newCount) {
return setCountImpl(this, element, oldCount, newCount);
}
// Bulk Operations
/**
* Returns {@code true} if this multiset contains all of the elements in the
* specified collection.
*
*
Note: this method does not take into account the occurrence
* count of an element in the two collections; it may still return {@code
* true} even if {@code elements} contains several occurrences of an element
* and this multiset contains only one. This is no different than any other
* collection type like {@link List}, but it may be unexpected to the user of
* a multiset.
*
*
This implementation checks whether {@link #elementSet} contains the
* elements.
*/
@Override public boolean containsAll(Collection elements) {
return elementSet().containsAll(elements);
}
/**
* Adds all of the elements in the specified collection to this multiset.
*
*
If the collection being added is a multiset, this implementation
* iterates over that multiset's entry set to add the appropriate number of
* occurrences of each of its elements to this multiset. Otherwise, it calls
* {@link AbstractCollection#addAll}.
*/
@Override public boolean addAll(Collection elementsToAdd) {
if (elementsToAdd.isEmpty()) {
return false;
}
if (elementsToAdd instanceof Multiset) {
@SuppressWarnings("unchecked")
Multiset that = (Multiset) elementsToAdd;
for (Entry entry : that.entrySet()) {
add(entry.getElement(), entry.getCount());
}
} else {
super.addAll(elementsToAdd);
}
return true;
}
/**
* Removes all of this multiset's elements that are also contained in the
* specified collection.
*
*
This implementation calls {@code removeAll()} on its
* {@link #elementSet()} with the given collection or, if
* {@code elementsToRemove} is a multiset, the elements in its element set. In
* some cases, this approach has better performance than
* {@link AbstractCollection#removeAll}.
*/
@Override public boolean removeAll(Collection elementsToRemove) {
Collection collection = (elementsToRemove instanceof Multiset)
? ((Multiset) elementsToRemove).elementSet() : elementsToRemove;
return elementSet().removeAll(collection);
// TODO: implement retainAll similarly?
}
/**
* Retains only the elements in this multiset that are contained in the
* specified collection.
*
*
This implementation iterates over {@link #entrySet()}, checking each
* entry's element to see if it's contained in the provided collection.
* If it's not found, the {@code remove} method of the entry set's
* iterator is invoked. In some cases, this approach has better performance
* than {@link AbstractCollection#removeAll}.
*/
@Override public boolean retainAll(Collection elementsToRetain) {
checkNotNull(elementsToRetain);
Iterator> entries = entrySet().iterator();
boolean modified = false;
while (entries.hasNext()) {
Entry entry = entries.next();
if (!elementsToRetain.contains(entry.getElement())) {
entries.remove();
modified = true;
}
}
return modified;
}
/**
* Removes all of the elements from this multiset.
*
* This implementation calls {@code clear} on {@link Multiset#entrySet()}.
*/
@Override public void clear() {
entrySet().clear();
}
// Views
private transient volatile Set elementSet;
/**
* {@inheritDoc}
*
* The returned set's methods are implemented by calling
* {@link Multiset#entrySet()} methods.
*/
public Set elementSet() {
Set result = elementSet;
if (result == null) {
elementSet = result = createElementSet();
}
return result;
}
/**
* Creates a new instance of this multiset's element set, which will be
* returned by {@link #elementSet()}.
*/
protected Set createElementSet() {
return new ElementSet();
}
private class ElementSet extends AbstractSet {
@Override public Iterator iterator() {
final Iterator> entryIterator = entrySet().iterator();
return new Iterator() {
public boolean hasNext() {
return entryIterator.hasNext();
}
public E next() {
return entryIterator.next().getElement();
}
public void remove() {
entryIterator.remove();
}
};
}
@Override public int size() {
return entrySet().size();
}
}
// Object methods
/**
* {@inheritDoc}
*
* This implementation returns {@code true} if {@code other} is a multiset
* of the same size and if, for each element, the two multisets have the same
* count.
*/
@Override public boolean equals(@Nullable Object object) {
if (object == this) {
return true;
}
if (object instanceof Multiset) {
Multiset that = (Multiset) object;
/*
* We can't simply check whether the entry sets are equal, since that
* approach fails when a TreeMultiset has a comparator that returns 0
* when passed unequal elements.
*/
if (this.size() != that.size()) {
return false;
}
for (Entry entry : that.entrySet()) {
if (count(entry.getElement()) != entry.getCount()) {
return false;
}
}
return true;
}
return false;
}
/**
* {@inheritDoc}
*
*
This implementation returns the hash code of {@link
* Multiset#entrySet()}.
*/
@Override public int hashCode() {
return entrySet().hashCode();
}
/**
* {@inheritDoc}
*
*
This implementation returns the result of invoking {@code toString} on
* {@link Multiset#entrySet()}.
*/
@Override public String toString() {
return entrySet().toString();
}
}