Modifier and Type	Class and Description
pack-priv class	AbstractMultimap.Entries
pack-priv class	AbstractMultimap.EntrySet
pack-priv class	AbstractMultimap.Values

Modifier and Type	Field and Description
private transient Map<K, Collection<V>>	asMap
private transient Collection<Map.Entry<K, V>>	entries
private transient Multiset<K>	keys
private transient Set<K>	keySet
private transient Collection<V>	values

Access	Constructor and Description
pack-priv	AbstractMultimap()

Method Summary

Modifier and Type	Method and Description
public Map<K, Collection<V>>	asMap() Implements com.google.common.collect.Multimap.asMap. Returns a view of this multimap as a `Map` from each distinct key to the nonempty collection of that key's associated values.
public boolean	containsEntry(Object key, Object value) Implements com.google.common.collect.Multimap.containsEntry. Returns `true` if this multimap contains at least one key-value pair with the key `key` and the value `value`.
public boolean	containsValue(Object value) Implements com.google.common.collect.Multimap.containsValue. Returns `true` if this multimap contains at least one key-value pair with the value `value`.
pack-priv abstract Map<K, Collection<V>>	createAsMap()
pack-priv abstract Collection<Map.Entry<K, V>>	createEntries()
pack-priv abstract Multiset<K>	createKeys()
pack-priv abstract Set<K>	createKeySet()
pack-priv abstract Collection<V>	createValues()
public Collection<Map.Entry<K, V>>	entries() Implements com.google.common.collect.Multimap.entries. Returns a view collection of all key-value pairs contained in this multimap, as `Entry` instances.
pack-priv abstract Iterator<Map.Entry<K, V>>	entryIterator()
pack-priv Spliterator<Map.Entry<K, V>>	entrySpliterator()
public boolean	equals(Object the reference object with which to compare. object) Overrides java.lang.Object.equals. Implements com.google.common.collect.Multimap.equals. Compares the specified object with this multimap for equality.
public int	hashCode() Overrides java.lang.Object.hashCode. Implements com.google.common.collect.Multimap.hashCode. Returns the hash code for this multimap.
public boolean	isEmpty() Implements com.google.common.collect.Multimap.isEmpty. Returns `true` if this multimap contains no key-value pairs.
public Multiset<K>	keys() Implements com.google.common.collect.Multimap.keys. Returns a view collection containing the key from each key-value pair in this multimap, without collapsing duplicates.
public Set<K>	keySet() Implements com.google.common.collect.Multimap.keySet. Returns a view collection of all distinct keys contained in this multimap.
public boolean	put(K key, V value) Implements com.google.common.collect.Multimap.put. Stores a key-value pair in this multimap.
public boolean	putAll(K key, Iterable<? extends V> values) Implements com.google.common.collect.Multimap.putAll. Stores a key-value pair in this multimap for each of `values`, all using the same key, `key`.
public boolean	putAll(Multimap<? extends K, ? extends V> multimap) Implements com.google.common.collect.Multimap.putAll. Stores all key-value pairs of `multimap` in this multimap, in the order returned by `multimap.entries()`.
public boolean	remove(Object key, Object value) Implements com.google.common.collect.Multimap.remove. Removes a single key-value pair with the key `key` and the value `value` from this multimap, if such exists.
public Collection<V>	replaceValues(K key, Iterable<? extends V> values) Implements com.google.common.collect.Multimap.replaceValues. Stores a collection of values with the same key, replacing any existing values for that key.
public String	Returns: a string representation of the multimap toString() Overrides java.lang.Object.toString. Returns a string representation of the multimap, generated by calling `toString` on the map returned by `Multimap#asMap`.
pack-priv Iterator<V>	valueIterator()
public Collection<V>	values() Implements com.google.common.collect.Multimap.values. Returns a view collection containing the value from each key-value pair contained in this multimap, without collapsing duplicates (so `values().size() == size()`).
pack-priv Spliterator<V>	valueSpliterator()

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

asMap	back to summary
private transient Map<K, Collection<V>> asMap Annotations @LazyInit @CheckForNull

entries	back to summary
private transient Collection<Map.Entry<K, V>> entries Annotations @LazyInit @CheckForNull

keys	back to summary
private transient Multiset<K> keys Annotations @LazyInit @CheckForNull

keySet	back to summary
private transient Set<K> keySet Annotations @LazyInit @CheckForNull

values	back to summary
private transient Collection<V> values Annotations @LazyInit @CheckForNull

Constructor Detail

AbstractMultimap	back to summary
pack-priv AbstractMultimap()

Method Detail

asMap back to summary

asMap	back to summary
public Map<K, Collection<V>> asMap() Implements com.google.common.collect.Multimap.asMap. Doc from com.google.common.collect.Multimap.asMap. Returns a view of this multimap as a `Map` from each distinct key to the nonempty collection of that key's associated values. Note that `this.asMap().get(k)` is equivalent to `this.get(k)` only when `k` is a key contained in the multimap; otherwise it returns `null` as opposed to an empty collection. Changes to the returned map or the collections that serve as its values will update the underlying multimap, and vice versa. The map does not support `put` or `putAll`, nor do its entries support `setValue`. Annotations @Override

public Map<K, Collection<V>> asMap()

Implements com.google.common.collect.Multimap.asMap.

Doc from com.google.common.collect.Multimap.asMap.

Returns a view of this multimap as a Map from each distinct key to the nonempty collection of that key's associated values. Note that this.asMap().get(k) is equivalent to this.get(k) only when k is a key contained in the multimap; otherwise it returns null as opposed to an empty collection.

Changes to the returned map or the collections that serve as its values will update the underlying multimap, and vice versa. The map does not support put or putAll, nor do its entries support setValue.

Annotations

@Override

containsEntry back to summary

containsEntry	back to summary
public boolean containsEntry(Object key, Object value) Implements com.google.common.collect.Multimap.containsEntry. Doc from com.google.common.collect.Multimap.containsEntry. Returns `true` if this multimap contains at least one key-value pair with the key `key` and the value `value`. Annotations @Override

public boolean containsEntry(Object key, Object value)

Implements com.google.common.collect.Multimap.containsEntry.

Doc from com.google.common.collect.Multimap.containsEntry.

Returns true if this multimap contains at least one key-value pair with the key key and the value value.

Annotations

@Override

containsValue back to summary

containsValue	back to summary
public boolean containsValue(Object value) Implements com.google.common.collect.Multimap.containsValue. Doc from com.google.common.collect.Multimap.containsValue. Returns `true` if this multimap contains at least one key-value pair with the value `value`. Annotations @Override

public boolean containsValue(Object value)

Implements com.google.common.collect.Multimap.containsValue.

Doc from com.google.common.collect.Multimap.containsValue.

Returns true if this multimap contains at least one key-value pair with the value value.

Annotations

@Override

createAsMap	back to summary
pack-priv abstract Map<K, Collection<V>> createAsMap()

createEntries	back to summary
pack-priv abstract Collection<Map.Entry<K, V>> createEntries()

createKeys	back to summary
pack-priv abstract Multiset<K> createKeys()

createKeySet	back to summary
pack-priv abstract Set<K> createKeySet()

createValues	back to summary
pack-priv abstract Collection<V> createValues()

entries back to summary

entries	back to summary
public Collection<Map.Entry<K, V>> entries() Implements com.google.common.collect.Multimap.entries. Doc from com.google.common.collect.Multimap.entries. Returns a view collection of all key-value pairs contained in this multimap, as `Entry` instances. Changes to the returned collection or the entries it contains will update the underlying multimap, and vice versa. However, adding to the returned collection is not possible. Annotations @Override

public Collection<Map.Entry<K, V>> entries()

Implements com.google.common.collect.Multimap.entries.

Doc from com.google.common.collect.Multimap.entries.

Returns a view collection of all key-value pairs contained in this multimap, as Entry instances.

Changes to the returned collection or the entries it contains will update the underlying multimap, and vice versa. However, adding to the returned collection is not possible.

Annotations

@Override

entryIterator	back to summary
pack-priv abstract Iterator<Map.Entry<K, V>> entryIterator()

entrySpliterator	back to summary
pack-priv Spliterator<Map.Entry<K, V>> entrySpliterator()

equals back to summary

equals	back to summary
public boolean equals(Object object) Overrides java.lang.Object.equals. Implements com.google.common.collect.Multimap.equals. Doc from com.google.common.collect.Multimap.equals. Compares the specified object with this multimap for equality. Two multimaps are equal when their map views, as returned by `asMap`, are also equal. In general, two multimaps with identical key-value mappings may or may not be equal, depending on the implementation. For example, two `SetMultimap` instances with the same key-value mappings are equal, but equality of two `ListMultimap` instances depends on the ordering of the values for each key. A non-empty `SetMultimap` cannot be equal to a non-empty `ListMultimap`, since their `asMap` views contain unequal collections as values. However, any two empty multimaps are equal, because they both have empty `asMap` views. Parameters object:Object Doc from java.lang.Object.equals. the reference object with which to compare. Returns:boolean Doc from java.lang.Object.equals. `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object object)

Overrides java.lang.Object.equals.

Implements com.google.common.collect.Multimap.equals.

Doc from com.google.common.collect.Multimap.equals.

Compares the specified object with this multimap for equality. Two multimaps are equal when their map views, as returned by asMap, are also equal.

In general, two multimaps with identical key-value mappings may or may not be equal, depending on the implementation. For example, two SetMultimap instances with the same key-value mappings are equal, but equality of two ListMultimap instances depends on the ordering of the values for each key.

A non-empty SetMultimap cannot be equal to a non-empty ListMultimap, since their asMap views contain unequal collections as values. However, any two empty multimaps are equal, because they both have empty asMap views.

Parameters

object:Object

Doc from java.lang.Object.equals.

the reference object with which to compare.

Returns:boolean

Doc from java.lang.Object.equals.

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Implements com.google.common.collect.Multimap.hashCode. Returns the hash code for this multimap. The hash code of a multimap is defined as the hash code of the map view, as returned by `Multimap#asMap`. Returns:int Doc from java.lang.Object.hashCode. a hash code value for this object Annotations @Override See Also `Map#hashCode`

public int hashCode()

Overrides java.lang.Object.hashCode.

Implements com.google.common.collect.Multimap.hashCode.

Returns the hash code for this multimap.

The hash code of a multimap is defined as the hash code of the map view, as returned by Multimap#asMap.

Returns:int

Doc from java.lang.Object.hashCode.

a hash code value for this object

Annotations

@Override

See Also

Map#hashCode

isEmpty back to summary

isEmpty	back to summary
public boolean isEmpty() Implements com.google.common.collect.Multimap.isEmpty. Doc from com.google.common.collect.Multimap.isEmpty. Returns `true` if this multimap contains no key-value pairs. Equivalent to `size() == 0`, but can in some cases be more efficient. Annotations @Override

public boolean isEmpty()

Implements com.google.common.collect.Multimap.isEmpty.

Doc from com.google.common.collect.Multimap.isEmpty.

Returns true if this multimap contains no key-value pairs. Equivalent to size() == 0, but can in some cases be more efficient.

Annotations

@Override

keys back to summary

keys	back to summary
public Multiset<K> keys() Implements com.google.common.collect.Multimap.keys. Doc from com.google.common.collect.Multimap.keys. Returns a view collection containing the key from each key-value pair in this multimap, without collapsing duplicates. This collection has the same size as this multimap, and `keys().count(k) == get(k).size()` for all `k`. Changes to the returned multiset will update the underlying multimap, and vice versa. However, adding to the returned collection is not possible. Annotations @Override

public Multiset<K> keys()

Implements com.google.common.collect.Multimap.keys.

Doc from com.google.common.collect.Multimap.keys.

Returns a view collection containing the key from each key-value pair in this multimap, without collapsing duplicates. This collection has the same size as this multimap, and keys().count(k) == get(k).size() for all k.

Changes to the returned multiset will update the underlying multimap, and vice versa. However, adding to the returned collection is not possible.

Annotations

@Override

keySet	back to summary
public Set<K> keySet() Implements com.google.common.collect.Multimap.keySet. Doc from com.google.common.collect.Multimap.keySet. Returns a view collection of all distinct keys contained in this multimap. Note that the key set contains a key if and only if this multimap maps that key to at least one value. Changes to the returned set will update the underlying multimap, and vice versa. However, adding to the returned set is not possible. Annotations @Override

keySet

back to summary

public Set<K> keySet()

Implements com.google.common.collect.Multimap.keySet.

Doc from com.google.common.collect.Multimap.keySet.

Returns a view collection of all distinct keys contained in this multimap. Note that the key set contains a key if and only if this multimap maps that key to at least one value.

Changes to the returned set will update the underlying multimap, and vice versa. However, adding to the returned set is not possible.

Annotations

@Override

put back to summary

put	back to summary
public boolean put(K key, V value) Implements com.google.common.collect.Multimap.put. Doc from com.google.common.collect.Multimap.put. Stores a key-value pair in this multimap. Some multimap implementations allow duplicate key-value pairs, in which case `put` always adds a new key-value pair and increases the multimap size by 1. Other implementations prohibit duplicates, and storing a key-value pair that's already in the multimap has no effect. Returns:boolean `true` if the method increased the size of the multimap, or `false` if the multimap already contained the key-value pair and doesn't allow duplicates Annotations @CanIgnoreReturnValue @Override

public boolean put(K key, V value)

Implements com.google.common.collect.Multimap.put.

Doc from com.google.common.collect.Multimap.put.

Stores a key-value pair in this multimap.

Some multimap implementations allow duplicate key-value pairs, in which case put always adds a new key-value pair and increases the multimap size by 1. Other implementations prohibit duplicates, and storing a key-value pair that's already in the multimap has no effect.

Returns:boolean

true if the method increased the size of the multimap, or false if the multimap already contained the key-value pair and doesn't allow duplicates

Annotations

@CanIgnoreReturnValue
@Override

putAll back to summary

putAll	back to summary
public boolean putAll(K key, Iterable<? extends V> values) Implements com.google.common.collect.Multimap.putAll. Doc from com.google.common.collect.Multimap.putAll. Stores a key-value pair in this multimap for each of `values`, all using the same key, `key`. Equivalent to (but expected to be more efficient than): `for (V value : values) { put(key, value); }` In particular, this is a no-op if `values` is empty. Returns:boolean `true` if the multimap changed Annotations @CanIgnoreReturnValue @Override

public boolean putAll(K key, Iterable<? extends V> values)

Implements com.google.common.collect.Multimap.putAll.

Doc from com.google.common.collect.Multimap.putAll.

Stores a key-value pair in this multimap for each of values, all using the same key, key. Equivalent to (but expected to be more efficient than):

for (V value : values) {
  put(key, value);
}

In particular, this is a no-op if values is empty.

Returns:boolean

true if the multimap changed

Annotations

@CanIgnoreReturnValue
@Override

putAll back to summary

putAll	back to summary
public boolean putAll(Multimap<? extends K, ? extends V> multimap) Implements com.google.common.collect.Multimap.putAll. Doc from com.google.common.collect.Multimap.putAll. Stores all key-value pairs of `multimap` in this multimap, in the order returned by `multimap.entries()`. Returns:boolean `true` if the multimap changed Annotations @CanIgnoreReturnValue @Override

public boolean putAll(Multimap<? extends K, ? extends V> multimap)

Implements com.google.common.collect.Multimap.putAll.

Doc from com.google.common.collect.Multimap.putAll.

Stores all key-value pairs of multimap in this multimap, in the order returned by multimap.entries().

Returns:boolean

true if the multimap changed

Annotations

@CanIgnoreReturnValue
@Override

remove back to summary

remove	back to summary
public boolean remove(Object key, Object value) Implements com.google.common.collect.Multimap.remove. Doc from com.google.common.collect.Multimap.remove. Removes a single key-value pair with the key `key` and the value `value` from this multimap, if such exists. If multiple key-value pairs in the multimap fit this description, which one is removed is unspecified. Returns:boolean `true` if the multimap changed Annotations @CanIgnoreReturnValue @Override

public boolean remove(Object key, Object value)

Implements com.google.common.collect.Multimap.remove.

Doc from com.google.common.collect.Multimap.remove.

Removes a single key-value pair with the key key and the value value from this multimap, if such exists. If multiple key-value pairs in the multimap fit this description, which one is removed is unspecified.

Returns:boolean

true if the multimap changed

Annotations

@CanIgnoreReturnValue
@Override

replaceValues back to summary

replaceValues	back to summary
public Collection<V> replaceValues(K key, Iterable<? extends V> values) Implements com.google.common.collect.Multimap.replaceValues. Doc from com.google.common.collect.Multimap.replaceValues. Stores a collection of values with the same key, replacing any existing values for that key. If `values` is empty, this is equivalent to `removeAll(key)`. Returns:Collection<V> the collection of replaced values, or an empty collection if no values were previously associated with the key. The collection may be modifiable, but updating it will have no effect on the multimap. Annotations @CanIgnoreReturnValue @Override

public Collection<V> replaceValues(K key, Iterable<? extends V> values)

Implements com.google.common.collect.Multimap.replaceValues.

Doc from com.google.common.collect.Multimap.replaceValues.

Stores a collection of values with the same key, replacing any existing values for that key.

If values is empty, this is equivalent to removeAll(key).

Returns:Collection<V>

the collection of replaced values, or an empty collection if no values were previously associated with the key. The collection may be modifiable, but updating it will have no effect on the multimap.

Annotations

@CanIgnoreReturnValue
@Override

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Returns a string representation of the multimap, generated by calling `toString` on the map returned by `Multimap#asMap`. Returns:String a string representation of the multimap Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Returns a string representation of the multimap, generated by calling toString on the map returned by Multimap#asMap.

Returns:String

a string representation of the multimap

Annotations

@Override

valueIterator	back to summary
pack-priv Iterator<V> valueIterator()

values back to summary

values	back to summary
public Collection<V> values() Implements com.google.common.collect.Multimap.values. Doc from com.google.common.collect.Multimap.values. Returns a view collection containing the value from each key-value pair contained in this multimap, without collapsing duplicates (so `values().size() == size()`). Changes to the returned collection will update the underlying multimap, and vice versa. However, adding to the returned collection is not possible. Annotations @Override

public Collection<V> values()

Implements com.google.common.collect.Multimap.values.

Doc from com.google.common.collect.Multimap.values.

Returns a view collection containing the value from each key-value pair contained in this multimap, without collapsing duplicates (so values().size() == size()).

Changes to the returned collection will update the underlying multimap, and vice versa. However, adding to the returned collection is not possible.

Annotations

@Override

valueSpliterator	back to summary
pack-priv Spliterator<V> valueSpliterator()

com.google.common.collect back to summary

pack-priv Class AbstractMultimap.Entries

Class Inheritance

extends Multimaps.Entries<K extends @Nullable Object, V extends @Nullable Object>

java.lang.Object
java.util.AbstractCollection
com.google.common.collect.Multimaps.Entries
com.google.common.collect.AbstractMultimap.Entries

Known Direct Subclasses

com.google.common.collect.AbstractMultimap.EntrySet

Annotations

@WeakOuter

Constructor Summary

Access	Constructor and Description
pack-priv	Entries()

Method Summary

Modifier and Type	Method and Description
public Iterator<Map.Entry<K, V>>	iterator() Implements abstract java.util.AbstractCollection.iterator. Implements java.util.Collection.iterator. Returns an iterator over the elements contained in this collection.
pack-priv Multimap<K, V>	multimap() Implements abstract com.google.common.collect.Multimaps.Entries.multimap.
public Spliterator<Map.Entry<K, V>>	spliterator() Overrides default java.util.Collection.spliterator. Creates a `Spliterator` over the elements in this collection.

Inherited from com.google.common.collect.Multimaps.Entries:: clear contains remove size

Constructor Detail

Entries	back to summary
pack-priv Entries()

Method Detail

iterator	back to summary
public Iterator<Map.Entry<K, V>> iterator() Implements abstract java.util.AbstractCollection.iterator. Implements java.util.Collection.iterator. Doc from java.util.AbstractCollection.iterator. Returns an iterator over the elements contained in this collection. Returns:Iterator<Map.Entry<K, V>> an iterator over the elements contained in this collection Annotations @Override

iterator

back to summary

public Iterator<Map.Entry<K, V>> iterator()

Implements abstract java.util.AbstractCollection.iterator.

Implements java.util.Collection.iterator.

Doc from java.util.AbstractCollection.iterator.

Returns an iterator over the elements contained in this collection.

Returns:Iterator<Map.Entry<K, V>>

an iterator over the elements contained in this collection

Annotations

@Override

multimap	back to summary
pack-priv Multimap<K, V> multimap() Implements abstract com.google.common.collect.Multimaps.Entries.multimap. Annotations @Override

multimap

back to summary

pack-priv Multimap<K, V> multimap()

Implements abstract com.google.common.collect.Multimaps.Entries.multimap.

Annotations

@Override

spliterator back to summary

spliterator	back to summary
public Spliterator<Map.Entry<K, V>> spliterator() Overrides default java.util.Collection.spliterator. Doc from java.util.Collection.spliterator. Creates a `Spliterator` over the elements in this collection. Implementations should document characteristic values reported by the spliterator. Such characteristic values are not required to be reported if the spliterator reports `Spliterator#SIZED` and this collection contains no elements. The default implementation should be overridden by subclasses that can return a more efficient spliterator. In order to preserve expected laziness behavior for the `stream()` and `parallelStream()` methods, spliterators should either have the characteristic of `IMMUTABLE` or `CONCURRENT`, or be late-binding. If none of these is practical, the overriding class should describe the spliterator's documented policy of binding and structural interference, and should override the `stream()` and `parallelStream()` methods to create streams using a `Supplier` of the spliterator, as in: `Stream<E> s = StreamSupport.stream(() -> spliterator(), spliteratorCharacteristics)` These requirements ensure that streams produced by the `stream()` and `parallelStream()` methods will reflect the contents of the collection as of initiation of the terminal stream operation. Returns:Spliterator<Map.Entry<K, V>> a `Spliterator` over the elements in this collection Annotations @Override

public Spliterator<Map.Entry<K, V>> spliterator()

Overrides default java.util.Collection.spliterator.

Doc from java.util.Collection.spliterator.

Creates a Spliterator over the elements in this collection. Implementations should document characteristic values reported by the spliterator. Such characteristic values are not required to be reported if the spliterator reports Spliterator#SIZED and this collection contains no elements.

The default implementation should be overridden by subclasses that can return a more efficient spliterator. In order to preserve expected laziness behavior for the stream() and parallelStream() methods, spliterators should either have the characteristic of IMMUTABLE or CONCURRENT, or be late-binding. If none of these is practical, the overriding class should describe the spliterator's documented policy of binding and structural interference, and should override the stream() and parallelStream() methods to create streams using a Supplier of the spliterator, as in:

Stream<E> s = StreamSupport.stream(() -> spliterator(), spliteratorCharacteristics)

These requirements ensure that streams produced by the stream() and parallelStream() methods will reflect the contents of the collection as of initiation of the terminal stream operation.

Returns:Spliterator<Map.Entry<K, V>>

a Spliterator over the elements in this collection

Annotations

@Override

com.google.common.collect back to summary

pack-priv Class AbstractMultimap.EntrySet

Class Inheritance

extends AbstractMultimap<K extends @Nullable Object, V extends @Nullable Object>.Entries
implements Set<Map.Entry<K extends @Nullable Object, V extends @Nullable Object>>

java.lang.Object
java.util.AbstractCollection
com.google.common.collect.Multimaps.Entries
com.google.common.collect.AbstractMultimap.Entries
com.google.common.collect.AbstractMultimap.EntrySet

All Implemented Interfaces

java.util.Set, java.util.Collection, java.lang.Iterable

Annotations

@WeakOuter

Constructor Summary

Access	Constructor and Description
pack-priv	EntrySet()

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object object to be compared for equality with this set obj) Overrides java.lang.Object.equals. Implements java.util.Set.equals, java.util.Collection.equals. Compares the specified object with this set for equality.
public int	hashCode() Overrides java.lang.Object.hashCode. Implements java.util.Set.hashCode, java.util.Collection.hashCode. Returns the hash code value for this set.

Inherited from com.google.common.collect.AbstractMultimap.Entries:: iterator multimap spliterator

Constructor Detail

EntrySet	back to summary
pack-priv EntrySet()

Method Detail

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Implements java.util.Set.equals, java.util.Collection.equals. Doc from java.util.Set.equals. Compares the specified object with this set for equality. Returns `true` if the specified object is also a set, the two sets have the same size, and every member of the specified set is contained in this set (or equivalently, every member of this set is contained in the specified set). This definition ensures that the equals method works properly across different implementations of the set interface. Parameters obj:Object object to be compared for equality with this set Returns:boolean `true` if the specified object is equal to this set Annotations @Override

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Implements java.util.Set.equals, java.util.Collection.equals.

Doc from java.util.Set.equals.

Compares the specified object with this set for equality. Returns true if the specified object is also a set, the two sets have the same size, and every member of the specified set is contained in this set (or equivalently, every member of this set is contained in the specified set). This definition ensures that the equals method works properly across different implementations of the set interface.

Parameters

obj:Object: object to be compared for equality with this set

Returns:boolean

true if the specified object is equal to this set

Annotations

@Override

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Implements java.util.Set.hashCode, java.util.Collection.hashCode. Doc from java.util.Set.hashCode. Returns the hash code value for this set. The hash code of a set is defined to be the sum of the hash codes of the elements in the set, where the hash code of a `null` element is defined to be zero. This ensures that `s1.equals(s2)` implies that `s1.hashCode()==s2.hashCode()` for any two sets `s1` and `s2`, as required by the general contract of `Object#hashCode`. Returns:int the hash code value for this set Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Implements java.util.Set.hashCode, java.util.Collection.hashCode.

Doc from java.util.Set.hashCode.

Returns the hash code value for this set. The hash code of a set is defined to be the sum of the hash codes of the elements in the set, where the hash code of a null element is defined to be zero. This ensures that s1.equals(s2) implies that s1.hashCode()==s2.hashCode() for any two sets s1 and s2, as required by the general contract of Object#hashCode.

Returns:int

the hash code value for this set

Annotations

@Override

com.google.common.collect back to summary

pack-priv Class AbstractMultimap.Values

Class Inheritance

extends AbstractCollection<V extends @Nullable Object>

java.lang.Object
java.util.AbstractCollection
com.google.common.collect.AbstractMultimap.Values

Annotations

@WeakOuter

Constructor Summary

Access	Constructor and Description
pack-priv	Values()

Method Summary

Modifier and Type	Method and Description
public void	clear() Overrides java.util.AbstractCollection.clear. Implements java.util.Collection.clear. Removes all of the elements from this collection (optional operation).
public boolean	contains(Object element whose presence in this collection is to be tested o) Overrides java.util.AbstractCollection.contains. Implements java.util.Collection.contains. Returns `true` if this collection contains the specified element.
public Iterator<V>	iterator() Implements abstract java.util.AbstractCollection.iterator. Implements java.util.Collection.iterator. Returns an iterator over the elements contained in this collection.
public int	size() Implements abstract java.util.AbstractCollection.size. Implements java.util.Collection.size. Returns the number of elements in this collection.
public Spliterator<V>	spliterator() Overrides default java.util.Collection.spliterator. Creates a `Spliterator` over the elements in this collection.

Inherited from java.util.AbstractCollection:: add addAll containsAll isEmpty remove removeAll retainAll toArray toArray toString

Constructor Detail

Values	back to summary
pack-priv Values()

Method Detail

clear	back to summary
public void clear() Overrides java.util.AbstractCollection.clear. Implements java.util.Collection.clear. Doc from java.util.AbstractCollection.clear. Removes all of the elements from this collection (optional operation). The collection will be empty after this method returns. Annotations @Override

clear

back to summary

public void clear()

Overrides java.util.AbstractCollection.clear.

Implements java.util.Collection.clear.

Doc from java.util.AbstractCollection.clear.

Removes all of the elements from this collection (optional operation). The collection will be empty after this method returns.

Annotations

@Override

contains back to summary

public boolean contains(Object o)

Overrides java.util.AbstractCollection.contains.

Implements java.util.Collection.contains.

Doc from java.util.AbstractCollection.contains.

Returns true if this collection contains the specified element. More formally, returns true if and only if this collection contains at least one element e such that Objects.equals(o, e).

Parameters

o:Object

Doc from java.util.Collection.contains.

element whose presence in this collection is to be tested

Returns:boolean

Doc from java.util.Collection.contains.

true if this collection contains the specified element

Annotations

@Override

iterator

back to summary

public Iterator<V> iterator()

Implements abstract java.util.AbstractCollection.iterator.

Implements java.util.Collection.iterator.

Doc from java.util.AbstractCollection.iterator.

Returns an iterator over the elements contained in this collection.

Returns:Iterator<V>

an iterator over the elements contained in this collection

Annotations

@Override

size back to summary

public int size()

Implements abstract java.util.AbstractCollection.size.

Implements java.util.Collection.size.

Doc from java.util.Collection.size.

Returns the number of elements in this collection. If this collection contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Returns:int

the number of elements in this collection

Annotations

@Override

spliterator back to summary

public Spliterator<V> spliterator()

Overrides default java.util.Collection.spliterator.

Doc from java.util.Collection.spliterator.

Stream<E> s = StreamSupport.stream(() -> spliterator(), spliteratorCharacteristics)

These requirements ensure that streams produced by the stream() and parallelStream() methods will reflect the contents of the collection as of initiation of the terminal stream operation.

Returns:Spliterator<V>

a Spliterator over the elements in this collection

Annotations

@Override

pack-priv abstract Class AbstractMultimap<K extends @Nullable Object, V extends @Nullable Object>

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class AbstractMultimap.Entries

Constructor Summary

Method Summary

Constructor Detail

Method Detail

pack-priv Class AbstractMultimap.EntrySet

Constructor Summary

Method Summary

Constructor Detail

Method Detail

pack-priv Class AbstractMultimap.Values

Constructor Summary

Method Summary

Constructor Detail

Method Detail