Class Synchronized.SynchronizedMultiset<E>
- java.lang.Object
-
- com.google.common.collect.Synchronized.SynchronizedObject
-
- com.google.common.collect.Synchronized.SynchronizedCollection<E>
-
- com.google.common.collect.Synchronized.SynchronizedMultiset<E>
-
- All Implemented Interfaces:
Multiset<E>
,java.io.Serializable
,java.lang.Iterable<E>
,java.util.Collection<E>
- Enclosing class:
- Synchronized
private static class Synchronized.SynchronizedMultiset<E> extends Synchronized.SynchronizedCollection<E> implements Multiset<E>
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface com.google.common.collect.Multiset
Multiset.Entry<E>
-
-
Field Summary
Fields Modifier and Type Field Description (package private) java.util.Set<E>
elementSet
(package private) java.util.Set<Multiset.Entry<E>>
entrySet
private static long
serialVersionUID
-
Fields inherited from class com.google.common.collect.Synchronized.SynchronizedObject
delegate, mutex
-
-
Constructor Summary
Constructors Constructor Description SynchronizedMultiset(Multiset<E> delegate, java.lang.Object mutex)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
add(E e, int n)
Adds a number of occurrences of an element to this multiset.int
count(java.lang.Object o)
Returns the number of occurrences of an element in this multiset (the count of the element).(package private) Multiset<E>
delegate()
java.util.Set<E>
elementSet()
Returns the set of distinct elements contained in this multiset.java.util.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(java.lang.Object o)
Compares the specified object with this multiset for equality.int
hashCode()
Returns the hash code for this multiset.int
remove(java.lang.Object o, int n)
Removes a number of occurrences of the specified element from this multiset.int
setCount(E element, int count)
Adds or removes the necessary occurrences of an element such that the element attains the desired count.boolean
setCount(E element, int oldCount, int newCount)
Conditionally sets the count of an element to a new value, as described inMultiset.setCount(Object, int)
, provided that the element has the expected current count.-
Methods inherited from class com.google.common.collect.Synchronized.SynchronizedCollection
add, addAll, clear, contains, containsAll, forEach, isEmpty, iterator, parallelStream, remove, removeAll, removeIf, retainAll, size, spliterator, stream, toArray, toArray
-
Methods inherited from class com.google.common.collect.Synchronized.SynchronizedObject
toString
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface java.util.Collection
addAll, clear, isEmpty, parallelStream, removeIf, stream, toArray, toArray, toArray
-
Methods inherited from interface com.google.common.collect.Multiset
add, contains, containsAll, forEach, forEachEntry, iterator, remove, removeAll, retainAll, size, spliterator, toString
-
-
-
-
Field Detail
-
elementSet
transient java.util.Set<E> elementSet
-
entrySet
transient java.util.Set<Multiset.Entry<E>> entrySet
-
serialVersionUID
private static final long serialVersionUID
- See Also:
- Constant Field Values
-
-
Method Detail
-
delegate
Multiset<E> delegate()
- Overrides:
delegate
in classSynchronized.SynchronizedCollection<E>
-
count
public int count(java.lang.Object o)
Description copied from interface:Multiset
Returns the number of occurrences of an element in this multiset (the count of the element). Note that for anObject.equals(java.lang.Object)
-based multiset, this gives the same result asCollections.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.
-
add
public int add(E e, int n)
Description copied from interface:Multiset
Adds a number of occurrences of an element to this multiset. Note that ifoccurrences == 1
, this method has the identical effect toMultiset.add(Object)
. This method is functionally equivalent (except in the case of overflow) to the calladdAll(Collections.nCopies(element, occurrences))
, which would presumably perform much more poorly.- Specified by:
add
in interfaceMultiset<E>
- Parameters:
e
- the element to add occurrences of; may be null only if explicitly allowed by the implementationn
- the number of occurrences of the element to add. May be zero, in which case no change will be made.- Returns:
- the count of the element before the operation; possibly zero
-
remove
public int remove(java.lang.Object o, int n)
Description copied from interface:Multiset
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. Note that ifoccurrences == 1
, this is functionally equivalent to the callremove(element)
.
-
setCount
public int setCount(E element, int count)
Description copied from interface:Multiset
Adds or removes the necessary occurrences of an element such that the element attains the desired count.- 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 the element before the operation; possibly zero
-
setCount
public boolean setCount(E element, int oldCount, int newCount)
Description copied from interface:Multiset
Conditionally sets the count of an element to a new value, as described inMultiset.setCount(Object, int)
, provided that the element has the expected current count. If the current count is notoldCount
, no change is 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 implementationoldCount
- the expected present count of the element in this multisetnewCount
- the desired count of the element in this multiset- Returns:
true
if the condition for modification was met. This implies that the multiset was indeed modified, unlessoldCount == newCount
.
-
elementSet
public java.util.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>
- Returns:
- a view of the set of distinct elements in this multiset
-
entrySet
public java.util.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 boolean equals(java.lang.Object o)
Description copied from interface:Multiset
Compares the specified object with this multiset for equality. Returnstrue
if the given object is also a multiset and contains equal elements with equal counts, regardless of order.
-
hashCode
public int hashCode()
Description copied from interface:Multiset
Returns the hash code for this multiset. This is defined as the sum of((element == null) ? 0 : element.hashCode()) ^ count(element)
over all distinct elements in the multiset. It follows that a multiset and its entry set always have the same hash code.
-
-