ImmutableMultimap (Eclipse Collections

All Superinterfaces:

Multimap<K,V>

All Known Subinterfaces:

ImmutableBagIterableMultimap<K,V>, ImmutableBagMultimap<K,V>, ImmutableListMultimap<K,V>, ImmutableSetIterableMultimap<K,V>, ImmutableSetMultimap<K,V>, ImmutableSortedBagMultimap<K,V>, ImmutableSortedSetMultimap<K,V>

All Known Implementing Classes:

AbstractImmutableMultimap, ImmutableBagMultimapImpl, ImmutableListMultimapImpl, ImmutableSetMultimapImpl, ImmutableSortedBagMultimapImpl, ImmutableSortedSetMultimapImpl
```
public interface ImmutableMultimap<K,V>
extends Multimap<K,V>
```
Since:

1.0

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`<K2,V2> ImmutableMultimap<K2,V2>`	`collectKeysValues(Function2<? super K,? super V,Pair<K2,V2>> function)` Returns a new multimap with the results of applying the specified function on each key and value of the source multimap.
`<V2> ImmutableMultimap<K,V2>`	`collectValues(Function<? super V,? extends V2> function)` Returns a new multimap with the results of applying the specified function on each value of the source multimap.
`ImmutableMultimap<V,K>`	`flip()` Given a Multimap from Domain -> Range return a multimap from Range -> Domain.
`ImmutableCollection<V>`	`get(K key)` Returns a view of all values associated with the given key.
`ImmutableMultimap<K,V>`	`newEmpty()` Creates a new instance of the same implementation type, using the default capacity and growth parameters.
`ImmutableMultimap<K,V>`	`newWith(K key, V value)`
`ImmutableMultimap<K,V>`	`newWithAll(K key, Iterable<? extends V> values)`
`ImmutableMultimap<K,V>`	`newWithout(Object key, Object value)`
`ImmutableMultimap<K,V>`	`newWithoutAll(Object key)`
`ImmutableMultimap<K,V>`	`rejectKeysMultiValues(Predicate2<? super K,? super Iterable<V>> predicate)` Returns all elements of the source multimap that don't satisfy the predicate.
`ImmutableMultimap<K,V>`	`rejectKeysValues(Predicate2<? super K,? super V> predicate)` Returns all elements of the source multimap that don't satisfy the predicate.
`ImmutableMultimap<K,V>`	`selectKeysMultiValues(Predicate2<? super K,? super Iterable<V>> predicate)` Returns all elements of the source multimap that satisfies the predicate.
`ImmutableMultimap<K,V>`	`selectKeysValues(Predicate2<? super K,? super V> predicate)` Returns all elements of the source multimap that satisfies the predicate.

Methods inherited from interface org.eclipse.collections.api.multimap.Multimap
collectKeysValues, collectValues, containsKey, containsKeyAndValue, containsValue, equals, forEachKey, forEachKeyMultiValues, forEachKeyValue, forEachValue, hashCode, isEmpty, keyBag, keyMultiValuePairsView, keysView, keyValuePairsView, multiValuesView, notEmpty, rejectKeysMultiValues, rejectKeysValues, selectKeysMultiValues, selectKeysValues, size, sizeDistinct, toImmutable, toMap, toMap, toMutable, valuesView

- Method Detail
  - newEmpty
```
ImmutableMultimap<K,V> newEmpty()
```
    Description copied from interface: Multimap
    
    Creates a new instance of the same implementation type, using the default capacity and growth parameters.
    
    Specified by:
    
    newEmpty in interface Multimap<K,V>
  - get
```
ImmutableCollection<V> get(K key)
```
    Description copied from interface: 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 Multimap<K,V>
    
    Parameters:
    
    key - the key to search for
  - newWith
```
ImmutableMultimap<K,V> newWith(K key,
                               V value)
```
  - newWithout
```
ImmutableMultimap<K,V> newWithout(Object key,
                                  Object value)
```
  - newWithAll
```
ImmutableMultimap<K,V> newWithAll(K key,
                                  Iterable<? extends V> values)
```
  - newWithoutAll
```
ImmutableMultimap<K,V> newWithoutAll(Object key)
```
  - flip
```
ImmutableMultimap<V,K> flip()
```
    Description copied from interface: Multimap
    
    Given a Multimap from Domain -> Range return a multimap from Range -> Domain.
    
    Specified by:
    
    flip in interface Multimap<K,V>
  - selectKeysValues
```
ImmutableMultimap<K,V> selectKeysValues(Predicate2<? super K,? super V> predicate)
```
    Description copied from interface: Multimap
    Returns all elements of the source multimap that satisfies the predicate. This method is also commonly called filter.
```
e.g.
 return multimap.selectKeysValues(new Predicate2<Integer, Person>()
 {
     public boolean accept(Integer age, Person person)
     {
         return (age >= 18)
                  && (person.getAddress().getCity().equals("Metuchen"));
     }
 });
 
```
    Specified by:
    
    selectKeysValues in interface Multimap<K,V>
    
    Parameters:
    
    predicate - a Predicate2 to use as the select criteria
    
    Returns:
    
    Multimap, which contains elements as a result of the select criteria
  - rejectKeysValues
```
ImmutableMultimap<K,V> rejectKeysValues(Predicate2<? super K,? super V> predicate)
```
    Description copied from interface: Multimap
    Returns all elements of the source multimap that don't satisfy the predicate.
```
e.g.
 return multimap.rejectKeysValues(new Predicate2<Integer, Person>()
 {
     public boolean accept(Integer age, Person person)
     {
         return (age >= 18)
                  && (person.getAddress().getCity().equals("Metuchen"));
     }
 });
 
```
    Specified by:
    
    rejectKeysValues in interface Multimap<K,V>
    
    Parameters:
    
    predicate - a Predicate2 to use as the reject criteria
    
    Returns:
    
    Multimap, which contains elements that don't satisfy the predicate
  - selectKeysMultiValues
```
ImmutableMultimap<K,V> selectKeysMultiValues(Predicate2<? super K,? super Iterable<V>> predicate)
```
    Description copied from interface: Multimap
    Returns all elements of the source multimap that satisfies the predicate. This method is also commonly called filter.
```
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);
     }
 });
 
```
    Specified by:
    
    selectKeysMultiValues in interface Multimap<K,V>
    
    Parameters:
    
    predicate - a Predicate2 to use as the select criteria
    
    Returns:
    
    Multimap, which contains elements as a result of the select criteria
  - rejectKeysMultiValues
```
ImmutableMultimap<K,V> rejectKeysMultiValues(Predicate2<? super K,? super Iterable<V>> predicate)
```
    Description copied from interface: Multimap
    Returns all elements of the source multimap that don't satisfy the predicate.
```
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);
     }
 });
 
```
    Specified by:
    
    rejectKeysMultiValues in interface Multimap<K,V>
    
    Parameters:
    
    predicate - a Predicate2 to use as the reject criteria
    
    Returns:
    
    Multimap, which contains elements that don't satisfy the predicate
  - collectKeysValues
```
<K2,V2> ImmutableMultimap<K2,V2> collectKeysValues(Function2<? super K,? super V,Pair<K2,V2>> function)
```
    Description copied from interface: Multimap
    Returns a new multimap with the results of applying the specified function on each key and value of the source multimap. This method is also commonly called transform or map.
```
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());
     }
 });
 
```
    Specified by:
    
    collectKeysValues in interface Multimap<K,V>
    
    Parameters:
    
    function - a Function2 to use for transformation
    
    Returns:
    
    Multimap, which contains elements as a result of the transformation
  - collectValues
```
<V2> ImmutableMultimap<K,V2> collectValues(Function<? super V,? extends V2> function)
```
    Description copied from interface: Multimap
    Returns a new multimap with the results of applying the specified function on each value of the source multimap. This method is also commonly called transform or map.
```
e.g.
 return multimap.collectValues(new Function<Person, String>()
 {
     public String valueOf(Person person)
     {
         return person.getLastName();
     }
 });
 
```
    Specified by:
    
    collectValues in interface Multimap<K,V>
    
    Parameters:
    
    function - a Function to use for transformation
    
    Returns:
    
    Multimap, which contains elements as a result of the transformation

Interface ImmutableMultimap<K,V>

Method Summary

Methods inherited from interface org.eclipse.collections.api.multimap.Multimap

Method Detail

newEmpty

get

newWith

newWithout

newWithAll

newWithoutAll

flip

selectKeysValues

rejectKeysValues

selectKeysMultiValues

rejectKeysMultiValues

collectKeysValues

collectValues