static class Multisets.UnmodifiableMultiset<E> extends ForwardingMultiset<E> implements java.io.Serializable
ForwardingMultiset.StandardElementSet
Multiset.Entry<E>
Modifier and Type | Field and Description |
---|---|
(package private) Multiset<? extends E> |
delegate |
(package private) java.util.Set<E> |
elementSet |
(package private) java.util.Set<Multiset.Entry<E>> |
entrySet |
private static long |
serialVersionUID |
Constructor and Description |
---|
UnmodifiableMultiset(Multiset<? extends E> delegate) |
Modifier and Type | Method and Description |
---|---|
boolean |
add(E element)
Adds a single occurrence of the specified element to this multiset.
|
int |
add(E element,
int occurences)
Adds a number of occurrences of an element to this multiset.
|
boolean |
addAll(java.util.Collection<? extends E> elementsToAdd) |
void |
clear() |
(package private) java.util.Set<E> |
createElementSet() |
protected Multiset<E> |
delegate()
Returns the backing delegate instance that methods are forwarded to.
|
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 into
Multiset.Entry instances, each providing an element of the multiset and
the count of that element. |
java.util.Iterator<E> |
iterator() |
boolean |
remove(java.lang.Object element)
Removes a single occurrence of the specified element from this
multiset, if present.
|
int |
remove(java.lang.Object element,
int occurrences)
Removes a number of occurrences of the specified element from this
multiset.
|
boolean |
removeAll(java.util.Collection<?> elementsToRemove) |
boolean |
retainAll(java.util.Collection<?> elementsToRetain) |
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 in
Multiset.setCount(Object, int) , provided that the element has the expected
current count. |
count, equals, hashCode, standardAdd, standardAddAll, standardClear, standardContains, standardCount, standardEquals, standardHashCode, standardIterator, standardRemove, standardRemoveAll, standardRetainAll, standardSetCount, standardSetCount, standardSize, standardToString
contains, containsAll, isEmpty, size, standardContainsAll, standardIsEmpty, standardToArray, standardToArray, toArray, toArray
toString
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
contains, containsAll, toString
transient java.util.Set<E> elementSet
transient java.util.Set<Multiset.Entry<E>> entrySet
private static final long serialVersionUID
protected Multiset<E> delegate()
ForwardingObject
ForwardingSet.delegate()
. Concrete subclasses override this method to supply
the instance being decorated.delegate
in class ForwardingMultiset<E>
java.util.Set<E> createElementSet()
public java.util.Set<E> elementSet()
Multiset
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()
.
elementSet
in interface Multiset<E>
elementSet
in class ForwardingMultiset<E>
public java.util.Set<Multiset.Entry<E>> entrySet()
Multiset
Multiset.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 the
Multiset.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 the Entry
instances themselves don't
even have methods for modification. See the specific implementation class
for more details on how its entry set handles modifications.
public java.util.Iterator<E> iterator()
Multiset
Elements that occur multiple times in the multiset will appear multiple times in this iterator, though not necessarily sequentially.
public boolean add(E element)
Multiset
This method refines Collection.add(E)
, which only ensures
the presence of the element, to further specify that a successful call must
always increment the count of the element, and the overall size of the
collection, by one.
To both add the element and obtain the previous count of that element,
use add
(element, 1)
instead.
add
in interface Multiset<E>
add
in interface java.util.Collection<E>
add
in class ForwardingCollection<E>
element
- the element to add one occurrence of; may be null only if
explicitly allowed by the implementationtrue
always, since this call is required to modify the
multiset, unlike other Collection
typespublic int add(E element, int occurences)
Multiset
occurrences == 1
, this method has the identical effect to Multiset.add(Object)
. This method is functionally equivalent (except in the case
of overflow) to the call addAll(Collections.nCopies(element,
occurrences))
, which would presumably perform much more poorly.add
in interface Multiset<E>
add
in class ForwardingMultiset<E>
element
- the element to add occurrences of; may be null only if
explicitly allowed by the implementationoccurences
- the number of occurrences of the element to add. May be
zero, in which case no change will be made.public boolean addAll(java.util.Collection<? extends E> elementsToAdd)
addAll
in interface java.util.Collection<E>
addAll
in class ForwardingCollection<E>
public boolean remove(java.lang.Object element)
Multiset
This method refines Collection.remove(java.lang.Object)
to further specify that it
may not throw an exception in response to element
being null
or of the wrong type.
To both remove the element and obtain the previous count of that element,
use remove
(element, 1)
instead.
public int remove(java.lang.Object element, int occurrences)
Multiset
occurrences == 1
, this is functionally equivalent to the call
remove(element)
.remove
in interface Multiset<E>
remove
in class ForwardingMultiset<E>
element
- the element to conditionally remove occurrences ofoccurrences
- the number of occurrences of the element to remove. May
be zero, in which case no change will be made.public boolean removeAll(java.util.Collection<?> elementsToRemove)
Multiset
Note: This method ignores how often any element might appear in
c
, and only cares whether or not an element appears at all.
If you wish to remove one occurrence in this multiset for every occurrence
in c
, see Multisets.removeOccurrences(Multiset, Multiset)
.
This method refines Collection.removeAll(java.util.Collection<?>)
to further specify that
it may not throw an exception in response to any of elements
being null or of the wrong type.
public boolean retainAll(java.util.Collection<?> elementsToRetain)
Multiset
Note: This method ignores how often any element might appear in
c
, and only cares whether or not an element appears at all.
If you wish to remove one occurrence in this multiset for every occurrence
in c
, see Multisets.retainOccurrences(Multiset, Multiset)
.
This method refines Collection.retainAll(java.util.Collection<?>)
to further specify that
it may not throw an exception in response to any of elements
being null or of the wrong type.
retainAll
in interface Multiset<E>
retainAll
in interface java.util.Collection<E>
retainAll
in class ForwardingCollection<E>
Multisets.retainOccurrences(Multiset, Multiset)
public void clear()
clear
in interface java.util.Collection<E>
clear
in class ForwardingCollection<E>
public int setCount(E element, int count)
Multiset
setCount
in interface Multiset<E>
setCount
in class ForwardingMultiset<E>
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 multisetpublic boolean setCount(E element, int oldCount, int newCount)
Multiset
Multiset.setCount(Object, int)
, provided that the element has the expected
current count. If the current count is not oldCount
, no change is
made.setCount
in interface Multiset<E>
setCount
in class ForwardingMultiset<E>
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 multisettrue
if the condition for modification was met. This
implies that the multiset was indeed modified, unless
oldCount == newCount
.