Class ConcurrentHashMultiset<E>
- java.lang.Object
-
- java.util.AbstractCollection<E>
-
- com.google.common.collect.ConcurrentHashMultiset<E>
-
- All Implemented Interfaces:
Multiset<E>
,Serializable
,Iterable<E>
,Collection<E>
@GwtIncompatible public final class ConcurrentHashMultiset<E> extends AbstractCollection<E> implements Serializable
A multiset that supports concurrent modifications and that provides atomic versions of mostMultiset
operations (exceptions where noted). Null elements are not supported.See the Guava User Guide article on
Multiset
.- Since:
- 2.0
- Author:
- Cliff L. Biffle, mike nonemacher
- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface com.google.common.collect.Multiset
Multiset.Entry<E extends @Nullable Object>
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description boolean
add(E element)
Ensures that this collection contains the specified element (optional operation).int
add(E element, int occurrences)
Adds a number of occurrences of the specified element to this multiset.boolean
addAll(Collection<? extends E> elementsToAdd)
Adds all of the elements in the specified collection to this collection (optional operation).void
clear()
Removes all of the elements from this collection (optional operation).boolean
contains(Object element)
Returnstrue
if this collection contains the specified element.int
count(Object element)
Returns the number of occurrences ofelement
in this multiset.static <E> ConcurrentHashMultiset<E>
create()
Creates a new, emptyConcurrentHashMultiset
using the default initial capacity, load factor, and concurrency settings.static <E> ConcurrentHashMultiset<E>
create(Iterable<? extends E> elements)
Creates a newConcurrentHashMultiset
containing the specified elements, using the default initial capacity, load factor, and concurrency settings.static <E> ConcurrentHashMultiset<E>
create(ConcurrentMap<E,AtomicInteger> countMap)
Creates a new, emptyConcurrentHashMultiset
usingcountMap
as the internal backing map.Set<Multiset.Entry<E>>
createEntrySet()
Deprecated.Internal method, useMultiset.entrySet()
.Set<E>
elementSet()
Returns the set of distinct elements contained in this multiset.Set<Multiset.Entry<E>>
entrySet()
Returns a view of the contents of this multiset, grouped intoMultiset.Entry
instances, each providing an element of the multiset and the count of that element.boolean
equals(Object object)
Indicates whether some other object is "equal to" this one.int
hashCode()
Returns a hash code value for the object.boolean
isEmpty()
Returnstrue
if this collection contains no elements.Iterator<E>
iterator()
Returns an iterator over the elements contained in this collection.boolean
remove(Object element)
Removes a single instance of the specified element from this collection, if it is present (optional operation).int
remove(Object element, int occurrences)
Removes a number of occurrences of the specified element from this multiset.boolean
removeAll(Collection<?> elementsToRemove)
Removes all of this collection's elements that are also contained in the specified collection (optional operation).boolean
removeExactly(Object element, int occurrences)
Removes exactly the specified number of occurrences ofelement
, or makes no change if this is not possible.boolean
retainAll(Collection<?> elementsToRetain)
Retains only the elements in this collection that are contained in the specified collection (optional operation).int
setCount(E element, int count)
Adds or removes occurrences ofelement
such that thecount(java.lang.Object)
of the element becomescount
.boolean
setCount(E element, int expectedOldCount, int newCount)
Sets the number of occurrences ofelement
tonewCount
, but only if the count is currentlyexpectedOldCount
.int
size()
Returns the number of elements in this collection.Object[]
toArray()
Returns an array containing all of the elements in this collection.<T extends @Nullable Object>
T[]toArray(T[] array)
Returns an array containing all of the elements in this collection; the runtime type of the returned array is that of the specified array.String
toString()
Returns a string representation of this collection.-
Methods inherited from class java.util.AbstractCollection
containsAll
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface java.util.Collection
parallelStream, removeIf, spliterator, stream, toArray
-
Methods inherited from interface com.google.common.collect.Multiset
containsAll
-
-
-
-
Method Detail
-
create
public static <E> ConcurrentHashMultiset<E> create()
Creates a new, emptyConcurrentHashMultiset
using the default initial capacity, load factor, and concurrency settings.
-
create
public static <E> ConcurrentHashMultiset<E> create(Iterable<? extends E> elements)
Creates a newConcurrentHashMultiset
containing the specified elements, using the default initial capacity, load factor, and concurrency settings.This implementation is highly efficient when
elements
is itself aMultiset
.- Parameters:
elements
- the elements that the multiset should contain
-
create
@Beta public static <E> ConcurrentHashMultiset<E> create(ConcurrentMap<E,AtomicInteger> countMap)
Creates a new, emptyConcurrentHashMultiset
usingcountMap
as the internal backing map.This instance will assume ownership of
countMap
, and other code should not maintain references to the map or modify it in any way.The returned multiset is serializable if the input map is.
- Parameters:
countMap
- backing map for storing the elements in the multiset and their counts. It must be empty.- Throws:
IllegalArgumentException
- ifcountMap
is not empty- Since:
- 20.0
-
count
public int count(@CheckForNull Object element)
Returns the number of occurrences ofelement
in this multiset.
-
size
public int size()
Returns the number of elements in this collection. If this collection contains more thanInteger.MAX_VALUE
elements, returnsInteger.MAX_VALUE
.If the data in the multiset is modified by any other threads during this method, it is undefined which (if any) of these modifications will be reflected in the result.
- Specified by:
size
in interfaceCollection<E>
- Specified by:
size
in interfaceMultiset<E>
- Specified by:
size
in classAbstractCollection<E>
- Returns:
- the number of elements in this collection
-
toArray
public Object[] toArray()
Description copied from class:java.util.AbstractCollection
Returns an array containing all of the elements in this collection. If this collection makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order. The returned array's runtime component type isObject
.The returned array will be "safe" in that no references to it are maintained by this collection. (In other words, this method must allocate a new array even if this collection is backed by an array). The caller is thus free to modify the returned array.
- Specified by:
toArray
in interfaceCollection<E>
- Overrides:
toArray
in classAbstractCollection<E>
- Returns:
- an array, whose runtime component
type is
Object
, containing all of the elements in this collection
-
toArray
public <T extends @Nullable Object> T[] toArray(T[] array)
Description copied from class:java.util.AbstractCollection
Returns an array containing all of the elements in this collection; the runtime type of the returned array is that of the specified array. If the collection fits in the specified array, it is returned therein. Otherwise, a new array is allocated with the runtime type of the specified array and the size of this collection.If this collection fits in the specified array with room to spare (i.e., the array has more elements than this collection), the element in the array immediately following the end of the collection is set to
null
. (This is useful in determining the length of this collection only if the caller knows that this collection does not contain anynull
elements.)If this collection makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order.
- Specified by:
toArray
in interfaceCollection<E>
- Overrides:
toArray
in classAbstractCollection<E>
- Type Parameters:
T
- the component type of the array to contain the collection- Parameters:
array
- the array into which the elements of this collection are to be stored, if it is big enough; otherwise, a new array of the same runtime type is allocated for this purpose.- Returns:
- an array containing all of the elements in this collection
-
add
@CanIgnoreReturnValue public int add(E element, int occurrences)
Adds a number of occurrences of the specified element to this multiset.- Specified by:
add
in interfaceMultiset<E>
- Parameters:
element
- the element to addoccurrences
- the number of occurrences to add- Returns:
- the previous count of the element before the operation; possibly zero
- Throws:
IllegalArgumentException
- ifoccurrences
is negative, or if the resulting amount would exceedInteger.MAX_VALUE
-
remove
@CanIgnoreReturnValue public int remove(@CheckForNull Object element, int occurrences)
Removes a number of occurrences of the specified element from this multiset. If the multiset contains fewer than this number of occurrences to begin with, all occurrences will be removed.- Specified by:
remove
in interfaceMultiset<E>
- Parameters:
element
- the element whose occurrences should be removedoccurrences
- the number of occurrences of the element to remove- Returns:
- the count of the element before the operation; possibly zero
- Throws:
IllegalArgumentException
- ifoccurrences
is negative
-
removeExactly
@CanIgnoreReturnValue public boolean removeExactly(@CheckForNull Object element, int occurrences)
Removes exactly the specified number of occurrences ofelement
, or makes no change if this is not possible.This method, in contrast to
remove(Object, int)
, has no effect when the element count is smaller thanoccurrences
.- Parameters:
element
- the element to removeoccurrences
- the number of occurrences ofelement
to remove- Returns:
true
if the removal was possible (including ifoccurrences
is zero)- Throws:
IllegalArgumentException
- ifoccurrences
is negative
-
setCount
@CanIgnoreReturnValue public int setCount(E element, int count)
Adds or removes occurrences ofelement
such that thecount(java.lang.Object)
of the element becomescount
.- Specified by:
setCount
in interfaceMultiset<E>
- Parameters:
element
- the element to add or remove occurrences of; may be null only if explicitly allowed by the implementationcount
- the desired count of the element in this multiset- Returns:
- the count of
element
in the multiset before this call - Throws:
IllegalArgumentException
- ifcount
is negative
-
setCount
@CanIgnoreReturnValue public boolean setCount(E element, int expectedOldCount, int newCount)
Sets the number of occurrences ofelement
tonewCount
, but only if the count is currentlyexpectedOldCount
. Ifelement
does not appear in the multiset exactlyexpectedOldCount
times, no changes will be made.- Specified by:
setCount
in interfaceMultiset<E>
- Parameters:
element
- the element to conditionally set the count of; may be null only if explicitly allowed by the implementationexpectedOldCount
- the expected present count of the element in this multisetnewCount
- the desired count of the element in this multiset- Returns:
true
if the change was successful. This usually indicates that the multiset has been modified, but not always: in the case thatexpectedOldCount == newCount
, the method will returntrue
if the condition was met.- Throws:
IllegalArgumentException
- ifexpectedOldCount
ornewCount
is negative
-
createEntrySet
@Deprecated public Set<Multiset.Entry<E>> createEntrySet()
Deprecated.Internal method, useMultiset.entrySet()
.
-
isEmpty
public boolean isEmpty()
Description copied from class:java.util.AbstractCollection
Returnstrue
if this collection contains no elements.- Specified by:
isEmpty
in interfaceCollection<E>
- Returns:
true
if this collection contains no elements
-
iterator
public Iterator<E> iterator()
Description copied from class:java.util.AbstractCollection
Returns an iterator over the elements contained in this collection.
-
clear
public void clear()
Description copied from class:java.util.AbstractCollection
Removes all of the elements from this collection (optional operation). The collection will be empty after this method returns.- Specified by:
clear
in interfaceCollection<E>
-
contains
public boolean contains(@CheckForNull Object element)
Description copied from class:java.util.AbstractCollection
Returnstrue
if this collection contains the specified element. More formally, returnstrue
if and only if this collection contains at least one elemente
such thatObjects.equals(o, e)
.- Specified by:
contains
in interfaceCollection<E extends @Nullable Object>
- Specified by:
contains
in interfaceMultiset<E extends @Nullable Object>
- Overrides:
contains
in classAbstractCollection<E extends @Nullable Object>
- Parameters:
element
- element whose presence in this collection is to be tested- Returns:
true
if this collection contains the specified element
-
add
@CanIgnoreReturnValue public final boolean add(E element)
Description copied from class:java.util.AbstractCollection
Ensures that this collection contains the specified element (optional operation). Returnstrue
if this collection changed as a result of the call. (Returnsfalse
if this collection does not permit duplicates and already contains the specified element.)Collections that support this operation may place limitations on what elements may be added to this collection. In particular, some collections will refuse to add
null
elements, and others will impose restrictions on the type of elements that may be added. Collection classes should clearly specify in their documentation any restrictions on what elements may be added.If a collection refuses to add a particular element for any reason other than that it already contains the element, it must throw an exception (rather than returning
false
). This preserves the invariant that a collection always contains the specified element after this call returns.- Specified by:
add
in interfaceCollection<E extends @Nullable Object>
- Specified by:
add
in interfaceMultiset<E extends @Nullable Object>
- Overrides:
add
in classAbstractCollection<E extends @Nullable Object>
- Parameters:
element
- element whose presence in this collection is to be ensured- Returns:
true
if this collection changed as a result of the call
-
remove
@CanIgnoreReturnValue public final boolean remove(@CheckForNull Object element)
Description copied from class:java.util.AbstractCollection
Removes a single instance of the specified element from this collection, if it is present (optional operation). More formally, removes an elemente
such thatObjects.equals(o, e)
, if this collection contains one or more such elements. Returnstrue
if this collection contained the specified element (or equivalently, if this collection changed as a result of the call).- Specified by:
remove
in interfaceCollection<E extends @Nullable Object>
- Specified by:
remove
in interfaceMultiset<E extends @Nullable Object>
- Overrides:
remove
in classAbstractCollection<E extends @Nullable Object>
- Parameters:
element
- element to be removed from this collection, if present- Returns:
true
if an element was removed as a result of this call
-
addAll
@CanIgnoreReturnValue public final boolean addAll(Collection<? extends E> elementsToAdd)
Adds all of the elements in the specified collection to this collection (optional operation). The behavior of this operation is undefined if the specified collection is modified while the operation is in progress. (This implies that the behavior of this call is undefined if the specified collection is this collection, and this collection is nonempty.)This implementation is highly efficient when
elementsToAdd
is itself aMultiset
.- Specified by:
addAll
in interfaceCollection<E extends @Nullable Object>
- Overrides:
addAll
in classAbstractCollection<E extends @Nullable Object>
- Parameters:
elementsToAdd
- collection containing elements to be added to this collection- Returns:
true
if this collection changed as a result of the call- See Also:
AbstractCollection.add(Object)
-
removeAll
@CanIgnoreReturnValue public final boolean removeAll(Collection<?> elementsToRemove)
Description copied from class:java.util.AbstractCollection
Removes all of this collection's elements that are also contained in the specified collection (optional operation). After this call returns, this collection will contain no elements in common with the specified collection.- Specified by:
removeAll
in interfaceCollection<E extends @Nullable Object>
- Specified by:
removeAll
in interfaceMultiset<E extends @Nullable Object>
- Overrides:
removeAll
in classAbstractCollection<E extends @Nullable Object>
- Parameters:
elementsToRemove
- collection containing elements to be removed from this collection- Returns:
true
if this collection changed as a result of the call- See Also:
AbstractCollection.remove(Object)
,AbstractCollection.contains(Object)
-
retainAll
@CanIgnoreReturnValue public final boolean retainAll(Collection<?> elementsToRetain)
Description copied from class:java.util.AbstractCollection
Retains only the elements in this collection that are contained in the specified collection (optional operation). In other words, removes from this collection all of its elements that are not contained in the specified collection.- Specified by:
retainAll
in interfaceCollection<E extends @Nullable Object>
- Specified by:
retainAll
in interfaceMultiset<E extends @Nullable Object>
- Overrides:
retainAll
in classAbstractCollection<E extends @Nullable Object>
- Parameters:
elementsToRetain
- collection containing elements to be retained in this collection- Returns:
true
if this collection changed as a result of the call- See Also:
AbstractCollection.remove(Object)
,AbstractCollection.contains(Object)
-
elementSet
public Set<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 interfaceMultiset<E extends @Nullable Object>
- Returns:
- a view of the set of distinct elements in this multiset
-
entrySet
public Set<Multiset.Entry<E>> entrySet()
Description copied from interface:Multiset
Returns a view of the contents of this multiset, grouped intoMultiset.Entry
instances, each providing an element of the multiset and the count of that element. This set contains exactly one entry for each distinct element in the multiset (thus it always has the same size as theMultiset.elementSet()
). The order of the elements in the element set is unspecified.The entry set is backed by the same data as the multiset, so any change to either is immediately reflected in the other. However, multiset changes may or may not be reflected in any
Entry
instances already retrieved from the entry set (this is implementation-dependent). Furthermore, implementations are not required to support modifications to the entry set at all, and theEntry
instances themselves don't even have methods for modification. See the specific implementation class for more details on how its entry set handles modifications.
-
equals
public final boolean equals(@CheckForNull Object object)
Indicates whether some other object is "equal to" this one.The
equals
method implements an equivalence relation on non-null object references:- It is reflexive: for any non-null reference value
x
,x.equals(x)
should returntrue
. - It is symmetric: for any non-null reference values
x
andy
,x.equals(y)
should returntrue
if and only ify.equals(x)
returnstrue
. - It is transitive: for any non-null reference values
x
,y
, andz
, ifx.equals(y)
returnstrue
andy.equals(z)
returnstrue
, thenx.equals(z)
should returntrue
. - It is consistent: for any non-null reference values
x
andy
, multiple invocations ofx.equals(y)
consistently returntrue
or consistently returnfalse
, provided no information used inequals
comparisons on the objects is modified. - For any non-null reference value
x
,x.equals(null)
should returnfalse
.
The
equals
method for classObject
implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference valuesx
andy
, this method returnstrue
if and only ifx
andy
refer to the same object (x == y
has the valuetrue
).Note that it is generally necessary to override the
hashCode
method whenever this method is overridden, so as to maintain the general contract for thehashCode
method, which states that equal objects must have equal hash codes.This implementation returns
true
ifobject
is a multiset of the same size and if, for each element, the two multisets have the same count.- Specified by:
equals
in interfaceCollection<E extends @Nullable Object>
- Specified by:
equals
in interfaceMultiset<E extends @Nullable Object>
- Overrides:
equals
in classObject
- Parameters:
object
- the reference object with which to compare.- Returns:
true
if this object is the same as the obj argument;false
otherwise.- See Also:
Object.hashCode()
,HashMap
- It is reflexive: for any non-null reference value
-
hashCode
public final int hashCode()
Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided byHashMap
.The general contract of
hashCode
is:- Whenever it is invoked on the same object more than once during
an execution of a Java application, the
hashCode
method must consistently return the same integer, provided no information used inequals
comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. - If two objects are equal according to the
equals(Object)
method, then calling thehashCode
method on each of the two objects must produce the same integer result. - It is not required that if two objects are unequal
according to the
Object.equals(java.lang.Object)
method, then calling thehashCode
method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
As much as is reasonably practical, the hashCode method defined by class
Object
does return distinct integers for distinct objects. (The hashCode may or may not be implemented as some function of an object's memory address at some point in time.)This implementation returns the hash code of
Multiset.entrySet()
.- Specified by:
hashCode
in interfaceCollection<E extends @Nullable Object>
- Specified by:
hashCode
in interfaceMultiset<E extends @Nullable Object>
- Overrides:
hashCode
in classObject
- Returns:
- a hash code value for this object.
- See Also:
Object.equals(java.lang.Object)
,System.identityHashCode(java.lang.Object)
- Whenever it is invoked on the same object more than once during
an execution of a Java application, the
-
toString
public final String toString()
Returns a string representation of this collection. The string representation consists of a list of the collection's elements in the order they are returned by its iterator, enclosed in square brackets ("[]"
). Adjacent elements are separated by the characters", "
(comma and space). Elements are converted to strings as byString.valueOf(Object)
.This implementation returns the result of invoking
toString
onMultiset.entrySet()
.
-
-