AbstractImmutableMultimap (Goldman Sachs Collections

java.lang.Object
- com.gs.collections.impl.multimap.AbstractMultimap<K,V,C>
- - com.gs.collections.impl.multimap.AbstractImmutableMultimap<K,V,C>

All Implemented Interfaces:

com.gs.collections.api.multimap.ImmutableMultimap<K,V>, com.gs.collections.api.multimap.Multimap<K,V>

Direct Known Subclasses:

ImmutableBagMultimapImpl, ImmutableListMultimapImpl, ImmutableSetMultimapImpl, ImmutableSortedSetMultimapImpl
```
public abstract class AbstractImmutableMultimap<K,V,C extends com.gs.collections.api.collection.ImmutableCollection<V>>
extends AbstractMultimap<K,V,C>
implements com.gs.collections.api.multimap.ImmutableMultimap<K,V>
```

Field Summary

Fields
Modifier and Type Field and Description

protected com.gs.collections.api.map.ImmutableMap<K,C> map

Fields
Modifier and Type	Field and Description
`protected com.gs.collections.api.map.ImmutableMap<K,C>`	`map`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`AbstractImmutableMultimap(com.gs.collections.api.map.ImmutableMap<K,C> immutableMap)` Creates a new multimap that uses the provided immutableMap.
`protected`	`AbstractImmutableMultimap(com.gs.collections.api.map.MutableMap<K,C> map)` Creates a new multimap that clones the provided map into an ImmutableMap.

Method Summary

Methods
Modifier and Type	Method and Description
`C`	`get(K key)` Returns a view of all values associated with the given key.
`protected com.gs.collections.api.map.ImmutableMap<K,C>`	`getMap()`
`boolean`	`isEmpty()` Returns `true` if there are no entries.
`com.gs.collections.api.multimap.ImmutableMultimap<K,V>`	`newWith(K key, V value)`
`com.gs.collections.api.multimap.ImmutableMultimap<K,V>`	`newWithAll(K key, java.lang.Iterable<? extends V> values)`
`com.gs.collections.api.multimap.ImmutableMultimap<K,V>`	`newWithout(java.lang.Object key, java.lang.Object value)`
`com.gs.collections.api.multimap.ImmutableMultimap<K,V>`	`newWithoutAll(java.lang.Object key)`
`protected java.lang.Object`	`readResolve()`
`int`	`size()` Returns the number of key-value entry pairs.
`int`	`sizeDistinct()` Returns the number of distinct keys.
`com.gs.collections.api.multimap.ImmutableMultimap<K,V>`	`toImmutable()` Returns an immutable copy of this Multimap if it is not already immutable.
`com.gs.collections.api.map.MutableMap<K,com.gs.collections.api.RichIterable<V>>`	`toMap()` Returns a new `MutableMap` of keys from this Multimap to the mapped values as a `RichIterable`.

Methods inherited from class com.gs.collections.impl.multimap.AbstractMultimap
containsKey, containsKeyAndValue, containsValue, createCollection, createCollectionBlock, equals, forEachKey, forEachKeyValue, forEachValue, hashCode, keyBag, keyMultiValuePairsView, keysView, keyValuePairsView, multiValuesView, notEmpty, toMap, toString, valuesView

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.gs.collections.api.multimap.ImmutableMultimap
newEmpty

Methods inherited from interface com.gs.collections.api.multimap.Multimap
containsKey, containsKeyAndValue, containsValue, equals, forEachKey, forEachKeyValue, forEachValue, hashCode, keyBag, keyMultiValuePairsView, keysView, keyValuePairsView, multiValuesView, notEmpty, toMap, toMutable, valuesView

- Field Detail
  - map
```
protected final com.gs.collections.api.map.ImmutableMap<K,C extends com.gs.collections.api.collection.ImmutableCollection<V>> map
```
- Constructor Detail
  - AbstractImmutableMultimap
```
protected AbstractImmutableMultimap(com.gs.collections.api.map.MutableMap<K,C> map)
```
    Creates a new multimap that clones the provided map into an ImmutableMap.
    
    Parameters:
    map - place to store the mapping from each key to its corresponding values
  - AbstractImmutableMultimap
```
protected AbstractImmutableMultimap(com.gs.collections.api.map.ImmutableMap<K,C> immutableMap)
```
    Creates a new multimap that uses the provided immutableMap.
    
    Parameters:
    immutableMap - place to store the mapping from each key to its corresponding values
- Method Detail
  - getMap
```
protected com.gs.collections.api.map.ImmutableMap<K,C> getMap()
```
    Specified by:
    
    getMap in class AbstractMultimap<K,V,C extends com.gs.collections.api.collection.ImmutableCollection<V>>
  - size
```
public int size()
```
    Description copied from interface: com.gs.collections.api.multimap.Multimap
    
    Returns the number of key-value entry pairs.
    This method is implemented with O(1) (constant-time) performance.
    
    Specified by:
    
    size in interface com.gs.collections.api.multimap.Multimap<K,V>
  - sizeDistinct
```
public int sizeDistinct()
```
    Description copied from interface: com.gs.collections.api.multimap.Multimap
    
    Returns the number of distinct keys.
    
    Specified by:
    
    sizeDistinct in interface com.gs.collections.api.multimap.Multimap<K,V>
  - isEmpty
```
public boolean isEmpty()
```
    Description copied from interface: com.gs.collections.api.multimap.Multimap
    
    Returns true if there are no entries.
    
    Specified by:
    
    isEmpty in interface com.gs.collections.api.multimap.Multimap<K,V>
  - get
```
public C get(K key)
```
    Description copied from interface: com.gs.collections.api.multimap.Multimap
    
    Returns a view of all values associated with the given key.
    If the given key does not exist, an empty RichIterable is returned.
    
    Specified by:
    
    get in interface com.gs.collections.api.multimap.ImmutableMultimap<K,V>
    
    Specified by:
    
    get in interface com.gs.collections.api.multimap.Multimap<K,V>
    
    Parameters:
    key - the key to search for
  - toMap
```
public com.gs.collections.api.map.MutableMap<K,com.gs.collections.api.RichIterable<V>> toMap()
```
    Description copied from interface: com.gs.collections.api.multimap.Multimap
    
    Returns a new MutableMap of keys from this Multimap to the mapped values as a RichIterable.
    
    Specified by:
    
    toMap in interface com.gs.collections.api.multimap.Multimap<K,V>
  - newWith
```
public com.gs.collections.api.multimap.ImmutableMultimap<K,V> newWith(K key,
                                                             V value)
```
    Specified by:
    
    newWith in interface com.gs.collections.api.multimap.ImmutableMultimap<K,V>
  - newWithout
```
public com.gs.collections.api.multimap.ImmutableMultimap<K,V> newWithout(java.lang.Object key,
                                                                java.lang.Object value)
```
    Specified by:
    
    newWithout in interface com.gs.collections.api.multimap.ImmutableMultimap<K,V>
  - newWithAll
```
public com.gs.collections.api.multimap.ImmutableMultimap<K,V> newWithAll(K key,
                                                                java.lang.Iterable<? extends V> values)
```
    Specified by:
    
    newWithAll in interface com.gs.collections.api.multimap.ImmutableMultimap<K,V>
  - newWithoutAll
```
public com.gs.collections.api.multimap.ImmutableMultimap<K,V> newWithoutAll(java.lang.Object key)
```
    Specified by:
    
    newWithoutAll in interface com.gs.collections.api.multimap.ImmutableMultimap<K,V>
  - toImmutable
```
public com.gs.collections.api.multimap.ImmutableMultimap<K,V> toImmutable()
```
    Description copied from interface: com.gs.collections.api.multimap.Multimap
    
    Returns an immutable copy of this Multimap if it is not already immutable. If the Multimap is immutable, it will return itself.
    The returned Multimap will be Serializable if this Multimap is Serializable.
    
    Specified by:
    
    toImmutable in interface com.gs.collections.api.multimap.Multimap<K,V>
  - readResolve
```
protected java.lang.Object readResolve()
                                throws java.io.ObjectStreamException
```
    Throws:
    
    java.io.ObjectStreamException

Class AbstractImmutableMultimap<K,V,C extends com.gs.collections.api.collection.ImmutableCollection<V>>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.gs.collections.impl.multimap.AbstractMultimap

Methods inherited from class java.lang.Object

Methods inherited from interface com.gs.collections.api.multimap.ImmutableMultimap

Methods inherited from interface com.gs.collections.api.multimap.Multimap

Field Detail

map

Constructor Detail

AbstractImmutableMultimap

AbstractImmutableMultimap

Method Detail

getMap

size

sizeDistinct

isEmpty

get

toMap

newWith

newWithout

newWithAll

newWithoutAll

toImmutable

readResolve