Class ImmutableMultimap.Keys
- All Implemented Interfaces:
Multiset<K>,Serializable,Iterable<K>,Collection<K>
- Enclosing class:
ImmutableMultimap<K,V>
-
Nested Class Summary
Nested classes/interfaces inherited from class com.google.common.collect.ImmutableMultiset
ImmutableMultiset.Builder<E>, ImmutableMultiset.ElementSet<E>, ImmutableMultiset.EntrySetSerializedForm<E>, ImmutableMultiset.SerializedFormNested classes/interfaces inherited from interface com.google.common.collect.Multiset
Multiset.Entry<E> -
Field Summary
Fields inherited from class com.google.common.collect.ImmutableCollection
SPLITERATOR_CHARACTERISTICS -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanDetermines whether this multiset contains the specified element.intReturns the number of occurrences of an element in this multiset (the count of the element).Returns the set of distinct elements contained in this multiset.(package private) Multiset.Entry<K> getEntry(int index) (package private) booleanReturnstrueif this immutable collection's implementation contains references to user-created objects that aren't accessible via this collection's methods.private voidreadObject(ObjectInputStream stream) intsize()Returns the total number of all occurrences of all elements in this multiset.(package private) ObjectMethods inherited from class com.google.common.collect.ImmutableMultiset
add, asList, builder, copyFromEntries, copyIntoArray, copyOf, copyOf, copyOf, entrySet, equals, hashCode, iterator, of, of, of, of, of, of, of, remove, setCount, setCount, toImmutableMultiset, toImmutableMultiset, toStringMethods inherited from class com.google.common.collect.ImmutableCollection
add, addAll, clear, internalArray, internalArrayEnd, internalArrayStart, remove, removeAll, removeIf, retainAll, spliterator, toArray, toArrayMethods inherited from class java.util.AbstractCollection
containsAll, isEmptyMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface java.util.Collection
addAll, clear, isEmpty, parallelStream, removeIf, stream, toArray, toArray, toArrayMethods inherited from interface com.google.common.collect.Multiset
add, containsAll, forEach, forEachEntry, remove, removeAll, retainAll, spliterator
-
Constructor Details
-
Keys
Keys()
-
-
Method Details
-
contains
Description copied from interface:MultisetDetermines whether this multiset contains the specified element.This method refines
Collection.contains(java.lang.Object)to further specify that it may not throw an exception in response toelementbeing null or of the wrong type.- Specified by:
containsin interfaceCollection<K>- Specified by:
containsin interfaceMultiset<K>- Overrides:
containsin classImmutableMultiset<K>- Parameters:
object- the element to check for- Returns:
trueif this multiset contains at least one occurrence of the element
-
count
Description copied from interface:MultisetReturns 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.- Parameters:
element- the element to count occurrences of- Returns:
- the number of occurrences of the element in this multiset; possibly zero but never negative
-
elementSet
Description copied from interface:MultisetReturns 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:
elementSetin interfaceMultiset<K>- Specified by:
elementSetin classImmutableMultiset<K>- Returns:
- a view of the set of distinct elements in this multiset
-
size
public int size()Description copied from interface:MultisetReturns the total number of all occurrences of all elements in this multiset.Note: this method does not return the number of distinct elements in the multiset, which is given by
entrySet().size().- Specified by:
sizein interfaceCollection<K>- Specified by:
sizein interfaceMultiset<K>- Specified by:
sizein classAbstractCollection<K>
-
getEntry
- Specified by:
getEntryin classImmutableMultiset<K>
-
isPartialView
boolean isPartialView()Description copied from class:ImmutableCollectionReturnstrueif this immutable collection's implementation contains references to user-created objects that aren't accessible via this collection's methods. This is generally used to determine whethercopyOfimplementations should make an explicit copy to avoid memory leaks.- Specified by:
isPartialViewin classImmutableCollection<K>
-
writeReplace
Object writeReplace()- Overrides:
writeReplacein classImmutableMultiset<K>
-
readObject
- Throws:
InvalidObjectException
-