Package org.eclipse.collections.api.multimap.ordered

Interface ReversibleIterableMultimap<K,V>

All Superinterfaces:

Multimap<K,V>, OrderedIterableMultimap<K,V>

All Known Subinterfaces:

ImmutableListMultimap<K,V>, ImmutableSortedBagMultimap<K,V>, ImmutableSortedSetMultimap<K,V>, ListMultimap<K,V>, MutableListMultimap<K,V>, MutableSortedBagMultimap<K,V>, MutableSortedSetMultimap<K,V>, SortedBagMultimap<K,V>, SortedSetMultimap<K,V>

All Known Implementing Classes:

AbstractMutableListMultimap, FastListMultimap, ImmutableListMultimapImpl, ImmutableSortedBagMultimapImpl, ImmutableSortedSetMultimapImpl, MultiReaderFastListMultimap, SynchronizedListMultimap, SynchronizedPutFastListMultimap, SynchronizedPutTreeSortedSetMultimap, SynchronizedSortedBagMultimap, SynchronizedSortedSetMultimap, TreeBagMultimap, TreeBagMultimap, TreeBagMultimap, TreeSortedSetMultimap

public interface ReversibleIterableMultimap<K,V>
extends OrderedIterableMultimap<K,V>

Method Summary

Modifier and Type	Method	Description
<V2> ReversibleIterableMultimap<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.
ReversibleIterable<V>	get(K key)	Returns a view of all values associated with the given key.
ReversibleIterableMultimap<K,V>	newEmpty()	Creates a new instance of the same implementation type, using the default capacity and growth parameters.
ReversibleIterableMultimap<K,V>	rejectKeysMultiValues(Predicate2<? super K,? super Iterable<V>> predicate)	Returns all elements of the source multimap that don't satisfy the predicate.
ReversibleIterableMultimap<K,V>	rejectKeysValues(Predicate2<? super K,? super V> predicate)	Returns all elements of the source multimap that don't satisfy the predicate.
ReversibleIterableMultimap<K,V>	selectKeysMultiValues(Predicate2<? super K,? super Iterable<V>> predicate)	Returns all elements of the source multimap that satisfies the predicate.
ReversibleIterableMultimap<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

collectKeyMultiValues, collectKeysValues, collectValues, containsKey, containsKeyAndValue, containsValue, equals, flip, forEachKey, forEachKeyMultiValues, forEachKeyValue, forEachValue, hashCode, isEmpty, keyBag, keyMultiValuePairsView, keySet, keysView, keyValuePairsView, multiValuesView, notEmpty, rejectKeysMultiValues, rejectKeysValues, selectKeysMultiValues, selectKeysValues, size, sizeDistinct, toImmutable, toMap, toMap, toMutable, valuesView

Methods inherited from interface org.eclipse.collections.api.multimap.ordered.OrderedIterableMultimap

collectKeyMultiValues, collectKeysValues

Method Details

newEmpty

ReversibleIterableMultimap<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>

Specified by:

newEmpty in interface OrderedIterableMultimap<K,V>

get

ReversibleIterable<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>

Specified by:

get in interface OrderedIterableMultimap<K,V>

Parameters:

key - the key to search for

selectKeysValues

ReversibleIterableMultimap<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>

Specified by:

selectKeysValues in interface OrderedIterableMultimap<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

ReversibleIterableMultimap<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>

Specified by:

rejectKeysValues in interface OrderedIterableMultimap<K,V>

Parameters:

predicate - a Predicate2 to use as the reject criteria

Returns:

Multimap, which contains elements that don't satisfy the predicate

selectKeysMultiValues

ReversibleIterableMultimap<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>

Specified by:

selectKeysMultiValues in interface OrderedIterableMultimap<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

ReversibleIterableMultimap<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>

Specified by:

rejectKeysMultiValues in interface OrderedIterableMultimap<K,V>

Parameters:

predicate - a Predicate2 to use as the reject criteria

Returns:

Multimap, which contains elements that don't satisfy the predicate

collectValues

<V2> ReversibleIterableMultimap<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>

Specified by:

collectValues in interface OrderedIterableMultimap<K,V>

Parameters:

function - a Function to use for transformation

Returns:

Multimap, which contains elements as a result of the transformation