Package com.google.common.collect

Class RegularImmutableMultiset<E>

java.lang.Object

java.util.AbstractCollection<E>

com.google.common.collect.ImmutableCollection<E>

com.google.common.collect.ImmutableMultisetGwtSerializationDependencies<E>

com.google.common.collect.ImmutableMultiset<E>

com.google.common.collect.RegularImmutableMultiset<E>

All Implemented Interfaces:

Multiset<E>, java.io.Serializable, java.lang.Iterable<E>, java.util.Collection<E>

class RegularImmutableMultiset<E>
extends ImmutableMultiset<E>

Implementation of ImmutableMultiset with zero or more elements.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	RegularImmutableMultiset.NonTerminalEntry<E>

Nested classes/interfaces inherited from class com.google.common.collect.ImmutableMultiset

ImmutableMultiset.Builder<E>, ImmutableMultiset.ElementSet<E>, ImmutableMultiset.EntrySetSerializedForm<E>, ImmutableMultiset.SerializedForm

Nested classes/interfaces inherited from interface com.google.common.collect.Multiset

Multiset.Entry<E>

Field Summary

Fields

Modifier and Type	Field	Description
private ImmutableSet<E>	elementSet
(package private) static ImmutableMultiset<java.lang.Object>	EMPTY
private Multisets.ImmutableEntry<E>[]	entries
(package private) static double	HASH_FLOODING_FPP	Maximum allowed false positive probability of detecting a hash flooding attack given random input.
private int	hashCode
private Multisets.ImmutableEntry<E>[]	hashTable
(package private) static int	MAX_HASH_BUCKET_LENGTH	Maximum allowed length of a hash table bucket before falling back to a j.u.HashMap based implementation.
(package private) static double	MAX_LOAD_FACTOR	Closed addressing tends to perform well even with high load factors.
private int	size

Fields inherited from class com.google.common.collect.ImmutableCollection

SPLITERATOR_CHARACTERISTICS

Constructor Summary

Constructors

Modifier	Constructor	Description
private	RegularImmutableMultiset(Multisets.ImmutableEntry<E>[] entries, Multisets.ImmutableEntry<E>[] hashTable, int size, int hashCode, ImmutableSet<E> elementSet)

Method Summary

Modifier and Type	Method	Description
int	count(java.lang.Object element)	Returns the number of occurrences of an element in this multiset (the count of the element).
(package private) static <E> ImmutableMultiset<E>	create(java.util.Collection<? extends Multiset.Entry<? extends E>> entries)
ImmutableSet<E>	elementSet()	Returns the set of distinct elements contained in this multiset.
(package private) Multiset.Entry<E>	getEntry(int index)
int	hashCode()	Returns the hash code for this multiset.
private static boolean	hashFloodingDetected(Multisets.ImmutableEntry<?>[] hashTable)
(package private) boolean	isPartialView()	Returns true if this immutable collection's implementation contains references to user-created objects that aren't accessible via this collection's methods.
int	size()	Returns the total number of all occurrences of all elements in this multiset.

Methods inherited from class com.google.common.collect.ImmutableMultiset

add, asList, builder, contains, copyFromEntries, copyIntoArray, copyOf, copyOf, copyOf, entrySet, equals, iterator, of, of, of, of, of, of, of, remove, setCount, setCount, toImmutableMultiset, toImmutableMultiset, toString, writeReplace

Methods inherited from class com.google.common.collect.ImmutableCollection

add, addAll, clear, internalArray, internalArrayEnd, internalArrayStart, remove, removeAll, removeIf, retainAll, spliterator, toArray, toArray

Methods inherited from class java.util.AbstractCollection

containsAll, isEmpty

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, containsAll, forEach, forEachEntry, remove, removeAll, retainAll, spliterator

Field Detail

EMPTY

static final ImmutableMultiset<java.lang.Object> EMPTY

MAX_LOAD_FACTOR

static final double MAX_LOAD_FACTOR

Closed addressing tends to perform well even with high load factors. Being conservative here ensures that the table is still likely to be relatively sparse (hence it misses fast) while saving space.

See Also:

Constant Field Values

HASH_FLOODING_FPP

static final double HASH_FLOODING_FPP

Maximum allowed false positive probability of detecting a hash flooding attack given random input.

See Also:

Constant Field Values

MAX_HASH_BUCKET_LENGTH

static final int MAX_HASH_BUCKET_LENGTH

Maximum allowed length of a hash table bucket before falling back to a j.u.HashMap based implementation. Experimentally determined.

See Also:

Constant Field Values

entries

private final transient Multisets.ImmutableEntry<E>[] entries

hashTable

private final transient Multisets.ImmutableEntry<E>[] hashTable

size

private final transient int size

hashCode

private final transient int hashCode

elementSet

private transient ImmutableSet<E> elementSet

Constructor Detail

RegularImmutableMultiset

private RegularImmutableMultiset(Multisets.ImmutableEntry<E>[] entries,
                                 Multisets.ImmutableEntry<E>[] hashTable,
                                 int size,
                                 int hashCode,
                                 ImmutableSet<E> elementSet)

Method Detail

create

static <E> ImmutableMultiset<E> create(java.util.Collection<? extends Multiset.Entry<? extends E>> entries)

hashFloodingDetected

private static boolean hashFloodingDetected(Multisets.ImmutableEntry<?>[] hashTable)

isPartialView

boolean isPartialView()

Description copied from class: ImmutableCollection

Returns true if 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 whether copyOf implementations should make an explicit copy to avoid memory leaks.

Specified by:

isPartialView in class ImmutableCollection<E>

count

public int count(java.lang.Object element)

Description copied from interface: Multiset

Returns the number of occurrences of an element in this multiset (the count of the element). Note that for an Object.equals(java.lang.Object)-based multiset, this gives the same result as Collections.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

size

public int size()

Description copied from interface: Multiset

Returns 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:

size in interface java.util.Collection<E>

Specified by:

size in interface Multiset<E>

Specified by:

size in class java.util.AbstractCollection<E>

elementSet

public ImmutableSet<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 interface Multiset<E>

Specified by:

elementSet in class ImmutableMultiset<E>

Returns:

a view of the set of distinct elements in this multiset

getEntry

Multiset.Entry<E> getEntry(int index)

Specified by:

getEntry in class ImmutableMultiset<E>

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.

Specified by:

hashCode in interface java.util.Collection<E>

Specified by:

hashCode in interface Multiset<E>

Overrides:

hashCode in class ImmutableMultiset<E>