AbstractMultimap (Goldman Sachs Collections

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

All Implemented Interfaces:: com.gs.collections.api.multimap.Multimap<K,V>

Direct Known Subclasses:: AbstractImmutableMultimap, AbstractMutableMultimap

public abstract class AbstractMultimap<K,V,C extends com.gs.collections.api.RichIterable<V>>
extends java.lang.Object
implements com.gs.collections.api.multimap.Multimap<K,V>

Constructor Summary

Constructors
Constructor and Description

AbstractMultimap()

Constructors
Constructor and Description
`AbstractMultimap()`

Method Summary

Methods
Modifier and Type	Method and Description
`<K2,V2,R extends com.gs.collections.api.multimap.MutableMultimap<K2,V2>> R`	`collectKeysValues(com.gs.collections.api.block.function.Function2<? super K,? super V,com.gs.collections.api.tuple.Pair<K2,V2>> function, R target)` Same as the collect method but uses the specified target multimap for the results.
`<V2,R extends com.gs.collections.api.multimap.MutableMultimap<K,V2>> R`	`collectValues(com.gs.collections.api.block.function.Function<? super V,? extends V2> function, R target)` Same as the collect method but uses the specified target multimap for the results.
`boolean`	`containsKey(java.lang.Object key)` Returns `true` if any values are mapped to the specified key.
`boolean`	`containsKeyAndValue(java.lang.Object key, java.lang.Object value)` Returns `true` if the specified key-value pair is mapped.
`boolean`	`containsValue(java.lang.Object value)` Returns `true` if any key is mapped to the specified value.
`protected abstract C`	`createCollection()` Creates the collection of values for a single key.
`protected com.gs.collections.api.block.function.Function<AbstractMultimap<K,V,C>,C>`	`createCollectionBlock()`
`boolean`	`equals(java.lang.Object object)` Compares the specified object with this Multimap for equality.
`void`	`forEachKey(com.gs.collections.api.block.procedure.Procedure<? super K> procedure)` Calls the `procedure` with each key.
`void`	`forEachKeyMultiValues(com.gs.collections.api.block.procedure.Procedure2<K,? super java.lang.Iterable<V>> procedure)` Calls the `procedure` with each key-Iterable[value].
`void`	`forEachKeyValue(com.gs.collections.api.block.procedure.Procedure2<K,V> procedure)` Calls the `procedure` with each key-value pair.
`void`	`forEachValue(com.gs.collections.api.block.procedure.Procedure<? super V> procedure)` Calls the procedure with each value.
`protected abstract com.gs.collections.api.map.MapIterable<K,C>`	`getMap()`
`int`	`hashCode()` Returns the hash code for this multimap.
`com.gs.collections.api.bag.Bag<K>`	`keyBag()` Returns a `Bag` of keys with the count corresponding to the number of mapped values.
`com.gs.collections.api.RichIterable<com.gs.collections.api.tuple.Pair<K,com.gs.collections.api.RichIterable<V>>>`	`keyMultiValuePairsView()` Returns a lazy view of the pair of a key and and a lazy view of the values mapped to that key.
`com.gs.collections.api.RichIterable<K>`	`keysView()` Returns a lazy view of the unique keys.
`com.gs.collections.api.RichIterable<com.gs.collections.api.tuple.Pair<K,V>>`	`keyValuePairsView()` Returns a lazy view of all of the key/value pairs.
`com.gs.collections.api.RichIterable<com.gs.collections.api.RichIterable<V>>`	`multiValuesView()` Returns an unmodifiable view of all of the values mapped to each key.
`boolean`	`notEmpty()` Returns `true` if there is at least one entry.
`<R extends com.gs.collections.api.multimap.MutableMultimap<K,V>> R`	`rejectKeysMultiValues(com.gs.collections.api.block.predicate.Predicate2<? super K,? super java.lang.Iterable<V>> predicate, R target)` Same as the reject method but uses the specified target multimap for the results.
`<R extends com.gs.collections.api.multimap.MutableMultimap<K,V>> R`	`rejectKeysValues(com.gs.collections.api.block.predicate.Predicate2<? super K,? super V> predicate, R target)` Same as the reject method but uses the specified target multimap for the results.
`<R extends com.gs.collections.api.multimap.MutableMultimap<K,V>> R`	`selectKeysMultiValues(com.gs.collections.api.block.predicate.Predicate2<? super K,? super java.lang.Iterable<V>> predicate, R target)` Same as the select method but uses the specified target multimap for the results.
`<R extends com.gs.collections.api.multimap.MutableMultimap<K,V>> R`	`selectKeysValues(com.gs.collections.api.block.predicate.Predicate2<? super K,? super V> predicate, R target)` Same as the select method but uses the specified target multimap for the results.
`java.lang.String`	`toString()` Returns a string representation of the multimap, generated by calling `toString` on the map returned by `Multimap.toMap()`.
`com.gs.collections.api.RichIterable<V>`	`valuesView()` Returns a lazy flattened view of all the values.

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

Methods inherited from interface com.gs.collections.api.multimap.Multimap
collectKeysValues, collectValues, flip, get, isEmpty, newEmpty, rejectKeysMultiValues, rejectKeysValues, selectKeysMultiValues, selectKeysValues, size, sizeDistinct, toImmutable, toMap, toMap, toMutable

- Constructor Detail
  - AbstractMultimap
```
public AbstractMultimap()
```
- Method Detail
  - getMap
```
protected abstract com.gs.collections.api.map.MapIterable<K,C> getMap()
```
  - createCollection
```
protected abstract C createCollection()
```
    Creates the collection of values for a single key.
    Collections with weak, soft, or phantom references are not supported. Each call to createCollection should create a new instance.
    The returned collection class determines whether duplicate key-value pairs are allowed.
    
    Returns:
    an empty collection of values
  - createCollectionBlock
```
protected com.gs.collections.api.block.function.Function<AbstractMultimap<K,V,C>,C> createCollectionBlock()
```
  - containsKey
```
public boolean containsKey(java.lang.Object key)
```
    Description copied from interface: com.gs.collections.api.multimap.Multimap
    
    Returns true if any values are mapped to the specified key.
    
    Specified by:
    
    containsKey in interface com.gs.collections.api.multimap.Multimap<K,V>
    
    Parameters:
    key - the key to search for
  - containsValue
```
public boolean containsValue(java.lang.Object value)
```
    Description copied from interface: com.gs.collections.api.multimap.Multimap
    
    Returns true if any key is mapped to the specified value.
    
    Specified by:
    
    containsValue in interface com.gs.collections.api.multimap.Multimap<K,V>
    
    Parameters:
    value - the value to search for
  - containsKeyAndValue
```
public boolean containsKeyAndValue(java.lang.Object key,
                          java.lang.Object value)
```
    Description copied from interface: com.gs.collections.api.multimap.Multimap
    
    Returns true if the specified key-value pair is mapped.
    
    Specified by:
    
    containsKeyAndValue in interface com.gs.collections.api.multimap.Multimap<K,V>
    
    Parameters:
    key - the key to search for
    value - the value to search for
  - keysView
```
public com.gs.collections.api.RichIterable<K> keysView()
```
    Description copied from interface: com.gs.collections.api.multimap.Multimap
    
    Returns a lazy view of the unique keys.
    
    Specified by:
    
    keysView in interface com.gs.collections.api.multimap.Multimap<K,V>
  - multiValuesView
```
public com.gs.collections.api.RichIterable<com.gs.collections.api.RichIterable<V>> multiValuesView()
```
    Description copied from interface: com.gs.collections.api.multimap.Multimap
    
    Returns an unmodifiable view of all of the values mapped to each key.
    
    Specified by:
    
    multiValuesView in interface com.gs.collections.api.multimap.Multimap<K,V>
  - keyBag
```
public com.gs.collections.api.bag.Bag<K> keyBag()
```
    Description copied from interface: com.gs.collections.api.multimap.Multimap
    
    Returns a Bag of keys with the count corresponding to the number of mapped values.
    
    Specified by:
    
    keyBag in interface com.gs.collections.api.multimap.Multimap<K,V>
  - valuesView
```
public com.gs.collections.api.RichIterable<V> valuesView()
```
    Description copied from interface: com.gs.collections.api.multimap.Multimap
    
    Returns a lazy flattened view of all the values.
    
    Specified by:
    
    valuesView in interface com.gs.collections.api.multimap.Multimap<K,V>
  - keyMultiValuePairsView
```
public com.gs.collections.api.RichIterable<com.gs.collections.api.tuple.Pair<K,com.gs.collections.api.RichIterable<V>>> keyMultiValuePairsView()
```
    Description copied from interface: com.gs.collections.api.multimap.Multimap
    
    Returns a lazy view of the pair of a key and and a lazy view of the values mapped to that key.
    
    Specified by:
    
    keyMultiValuePairsView in interface com.gs.collections.api.multimap.Multimap<K,V>
  - keyValuePairsView
```
public com.gs.collections.api.RichIterable<com.gs.collections.api.tuple.Pair<K,V>> keyValuePairsView()
```
    Description copied from interface: com.gs.collections.api.multimap.Multimap
    
    Returns a lazy view of all of the key/value pairs.
    
    Specified by:
    
    keyValuePairsView in interface com.gs.collections.api.multimap.Multimap<K,V>
  - equals
```
public boolean equals(java.lang.Object object)
```
    Description copied from interface: com.gs.collections.api.multimap.Multimap
    
    Compares the specified object with this Multimap for equality.
    Two Multimaps are equal when their map views (as returned by Multimap.toMap()) are also equal.
    In general, two Multimaps with identical key-value mappings may or may not be equal, depending on the type of the collections holding the values. If the backing collections are Sets, then two instances with the same key-value mappings are equal, but if the backing collections are Lists, equality depends on the ordering of the values for each key.
    Any two empty Multimaps are equal, because they both have empty Multimap.toMap() views.
    
    Specified by:
    
    equals in interface com.gs.collections.api.multimap.Multimap<K,V>
    
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int 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.toMap().
    
    Specified by:
    
    hashCode in interface com.gs.collections.api.multimap.Multimap<K,V>
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    See Also:
    Map.hashCode()
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of the multimap, generated by calling toString on the map returned by Multimap.toMap().
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    a string representation of the multimap
  - notEmpty
```
public boolean notEmpty()
```
    Description copied from interface: com.gs.collections.api.multimap.Multimap
    
    Returns true if there is at least one entry.
    
    Specified by:
    
    notEmpty in interface com.gs.collections.api.multimap.Multimap<K,V>
  - forEachValue
```
public void forEachValue(com.gs.collections.api.block.procedure.Procedure<? super V> procedure)
```
    Description copied from interface: com.gs.collections.api.multimap.Multimap
    
    Calls the procedure with each value.
    Given a Multimap with the contents:
    { "key1" : ["val1", "val2", "val2"], "key2" : ["val3"] }
    The given procedure would be invoked with the parameters:
    [ "val1", "val2", "val2", "val3" ]
    
    Specified by:
    
    forEachValue in interface com.gs.collections.api.multimap.Multimap<K,V>
  - forEachKey
```
public void forEachKey(com.gs.collections.api.block.procedure.Procedure<? super K> procedure)
```
    Description copied from interface: com.gs.collections.api.multimap.Multimap
    
    Calls the procedure with each key.
    Given a Multimap with the contents:
    { "key1" : ["val1", "val2", "val2"], "key2" : ["val3"] }
    The given procedure would be invoked with the parameters:
    [ "key1", "key2" ]
    
    Specified by:
    
    forEachKey in interface com.gs.collections.api.multimap.Multimap<K,V>
  - forEachKeyValue
```
public void forEachKeyValue(com.gs.collections.api.block.procedure.Procedure2<K,V> procedure)
```
    Description copied from interface: com.gs.collections.api.multimap.Multimap
    
    Calls the procedure with each key-value pair.
    Given a Multimap with the contents:
    { "key1" : ["val1", "val2", "val2"], "key2" : ["val3"] }
    The given procedure would be invoked with the parameters:
    [ ["key1", "val1"], ["key1", "val2"], ["key1", "val2"], ["key2", "val3"] ]
    
    Specified by:
    
    forEachKeyValue in interface com.gs.collections.api.multimap.Multimap<K,V>
  - forEachKeyMultiValues
```
public void forEachKeyMultiValues(com.gs.collections.api.block.procedure.Procedure2<K,? super java.lang.Iterable<V>> procedure)
```
    Description copied from interface: com.gs.collections.api.multimap.Multimap
    
    Calls the procedure with each key-Iterable[value].
    Given a Multimap with the contents:
    { "key1" : ["val1", "val2", "val2"], "key2" : ["val3"] }
    The given procedure would be invoked with the parameters:
    [ ["key1", {@link RichIterable["val1", "val2", "val2"]}], ["key2", {@link RichIterable["val3"]}] ]
    
    Specified by:
    
    forEachKeyMultiValues in interface com.gs.collections.api.multimap.Multimap<K,V>
  - selectKeysValues
```
public <R extends com.gs.collections.api.multimap.MutableMultimap<K,V>> R selectKeysValues(com.gs.collections.api.block.predicate.Predicate2<? super K,? super V> predicate,
                                                                                  R target)
```
    Description copied from interface: com.gs.collections.api.multimap.Multimap
    Same as the select method but uses the specified target multimap for the results.
```
e.g.
 return multimap.selectKeysValues(new Predicate2<Integer, Person>()
 {
     public boolean accept(Integer age, Person person)
     {
         return (age >= 18)
                  && (person.getAddress().getCity().equals("Metuchen"));
     }
 }, FastListMultimap.newMultimap());
 
```
    Specified by:
    
    selectKeysValues in interface com.gs.collections.api.multimap.Multimap<K,V>
    
    Parameters:
    predicate - a Predicate2 to use as the select criteria
    target - the Multimap to append to for all elements in this Multimap that satisfy the predicate
    
    Returns:
    target, which contains appended elements as a result of the select criteria
  - rejectKeysValues
```
public <R extends com.gs.collections.api.multimap.MutableMultimap<K,V>> R rejectKeysValues(com.gs.collections.api.block.predicate.Predicate2<? super K,? super V> predicate,
                                                                                  R target)
```
    Description copied from interface: com.gs.collections.api.multimap.Multimap
    Same as the reject method but uses the specified target multimap for the results.
```
e.g.
 return multimap.rejectKeysValues(new Predicate2<Integer, Person>()
 {
     public boolean accept(Integer age, Person person)
     {
         return (age >= 18)
                  && (person.getAddress().getCity().equals("Metuchen"));
     }
 }, FastListMultimap.newMultimap());
 
```
    Specified by:
    
    rejectKeysValues in interface com.gs.collections.api.multimap.Multimap<K,V>
    
    Parameters:
    predicate - a Predicate2 to use as the reject criteria
    target - the Multimap to append to for all elements in this Multimap that don't satisfy the predicate
    
    Returns:
    target, which contains appended elements that don't satisfy the predicate
  - selectKeysMultiValues
```
public <R extends com.gs.collections.api.multimap.MutableMultimap<K,V>> R selectKeysMultiValues(com.gs.collections.api.block.predicate.Predicate2<? super K,? super java.lang.Iterable<V>> predicate,
                                                                                       R target)
```
    Description copied from interface: com.gs.collections.api.multimap.Multimap
    Same as the select method but uses the specified target multimap for the results.
```
e.g.
 return multimap.selectKeysMultiValues(new Predicate2<Integer, Iterable<Person>>()
 {
     public boolean accept(Integer age, Iterable<Person> values)
     {
         return (age >= 18)
                  && ((RichIterable<Person>)values.size() >= 2);
     }
 }, FastListMultimap.newMultimap());
 
```
    Specified by:
    
    selectKeysMultiValues in interface com.gs.collections.api.multimap.Multimap<K,V>
    
    Parameters:
    predicate - a Predicate2 to use as the select criteria
    target - the Multimap to append to for all elements in this Multimap that satisfy the predicate
    
    Returns:
    target, which contains appended elements as a result of the select criteria
  - rejectKeysMultiValues
```
public <R extends com.gs.collections.api.multimap.MutableMultimap<K,V>> R rejectKeysMultiValues(com.gs.collections.api.block.predicate.Predicate2<? super K,? super java.lang.Iterable<V>> predicate,
                                                                                       R target)
```
    Description copied from interface: com.gs.collections.api.multimap.Multimap
    Same as the reject method but uses the specified target multimap for the results.
```
e.g.
 return multimap.rejectKeysMultiValues(new Predicate2<Integer, Iterable<Person>>()
 {
     public boolean accept(Integer age, Iterable<Person> values)
     {
         return (age >= 18)
                  && ((RichIterable<Person>)values.size() >= 2);
     }
 }, FastListMultimap.newMultimap());
 
```
    Specified by:
    
    rejectKeysMultiValues in interface com.gs.collections.api.multimap.Multimap<K,V>
    
    Parameters:
    predicate - a Predicate2 to use as the reject criteria
    target - the Multimap to append to for all elements in this Multimap that don't satisfy the predicate
    
    Returns:
    target, which contains appended elements that don't satisfy the predicate
  - collectKeysValues
```
public <K2,V2,R extends com.gs.collections.api.multimap.MutableMultimap<K2,V2>> R collectKeysValues(com.gs.collections.api.block.function.Function2<? super K,? super V,com.gs.collections.api.tuple.Pair<K2,V2>> function,
                                                                                           R target)
```
    Description copied from interface: com.gs.collections.api.multimap.Multimap
    Same as the collect method but uses the specified target multimap for the results.
```
e.g.
 return multimap.collectKeysValues(new Function2<Integer, Person, Pair<String, String>>()
 {
     public Pair<String, String> valueOf(Integer age, Person person)
     {
         return Tuples.pair(age.toString(), person.getLastName());
     }
 }, HashBagMultimap.newMultimap());
 
```
    Specified by:
    
    collectKeysValues in interface com.gs.collections.api.multimap.Multimap<K,V>
    
    Parameters:
    function - a Function2 to use for transformation
    target - the Multimap to append for all elements in this Multimap that are evaluated in function
    
    Returns:
    target, which contains appended elements as a result of the transformation
  - collectValues
```
public <V2,R extends com.gs.collections.api.multimap.MutableMultimap<K,V2>> R collectValues(com.gs.collections.api.block.function.Function<? super V,? extends V2> function,
                                                                                   R target)
```
    Description copied from interface: com.gs.collections.api.multimap.Multimap
    Same as the collect method but uses the specified target multimap for the results.
```
e.g.
 return multimap.collectValues(new Function<Person, String>()
 {
     public String valueOf(Person person)
     {
         return person.getLastName();
     }
 }, FastListMultimap.newMultimap());
 
```
    Specified by:
    
    collectValues in interface com.gs.collections.api.multimap.Multimap<K,V>
    
    Parameters:
    function - a Function to use for transformation
    target - the Multimap to append for all elements in this Multimap that are evaluated in function
    
    Returns:
    target, which contains appended elements as a result of the transformation

Class AbstractMultimap<K,V,C extends com.gs.collections.api.RichIterable<V>>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractMultimap

Method Detail

getMap

createCollection

createCollectionBlock

containsKey

containsValue

containsKeyAndValue

keysView

multiValuesView

keyBag

valuesView

keyMultiValuePairsView

keyValuePairsView

equals

hashCode

toString

notEmpty

forEachValue

forEachKey

forEachKeyValue

forEachKeyMultiValues

selectKeysValues

rejectKeysValues

selectKeysMultiValues

rejectKeysMultiValues

collectKeysValues

collectValues