Package org.eclipse.collections.api.multimap.list

Interface ListMultimap<K,V>

All Superinterfaces:
Multimap<K,V>, OrderedIterableMultimap<K,V>, ReversibleIterableMultimap<K,V>
All Known Subinterfaces:
ImmutableListMultimap<K,V>, MutableListMultimap<K,V>
All Known Implementing Classes:
AbstractMutableListMultimap, FastListMultimap, ImmutableListMultimapImpl, MultiReaderFastListMultimap, SynchronizedListMultimap, SynchronizedPutFastListMultimap
public interface ListMultimap<K,V> extends ReversibleIterableMultimap<K,V>

  • Method Details

    • newEmpty

      ListMultimap<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>
      Specified by:
      newEmpty in interface ReversibleIterableMultimap<K,V>

    • get

      ListIterable<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>
      Specified by:
      get in interface ReversibleIterableMultimap<K,V>
      Parameters:
      key - the key to search for

    • toMutable

      MutableListMultimap<K,V> toMutable()
      Description copied from interface: Multimap
      Returns a mutable copy of this Multimap.
      Specified by:
      toMutable in interface Multimap<K,V>

    • toImmutable

      ImmutableListMultimap<K,V> toImmutable()
      Description copied from interface: 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 Multimap<K,V>

    • flip

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

      ListMultimap<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>
      Specified by:
      selectKeysValues in interface ReversibleIterableMultimap<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

      ListMultimap<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>
      Specified by:
      rejectKeysValues in interface ReversibleIterableMultimap<K,V>
      Parameters:
      predicate - a Predicate2 to use as the reject criteria
      Returns:
      Multimap, which contains elements that don't satisfy the predicate

    • selectKeysMultiValues

      ListMultimap<K,V> selectKeysMultiValues(Predicate2<? super K,? super RichIterable<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>
      Specified by:
      selectKeysMultiValues in interface ReversibleIterableMultimap<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

      ListMultimap<K,V> rejectKeysMultiValues(Predicate2<? super K,? super RichIterable<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>
      Specified by:
      rejectKeysMultiValues in interface ReversibleIterableMultimap<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> BagMultimap<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>
      Specified by:
      collectKeysValues in interface OrderedIterableMultimap<K,V>
      Parameters:
      function - a Function2 to use for transformation
      Returns:
      Multimap, which contains elements as a result of the transformation

    • collectKeyMultiValues

      <K2, V2> BagMultimap<K2,V2> collectKeyMultiValues(Function<? super K,? extends K2> keyFunction, Function<? super V,? extends V2> valueFunction)
      Description copied from interface: Multimap
      Returns a new multimap with the results of applying the specified keyFunction and valueFunction on each key and corresponding values of the source multimap. This method is also commonly called transform or map. 
      e.g.
 return multimap.collectKeyMultiValues(each -> each + 1, Person::getLastName);
      Specified by:
      collectKeyMultiValues in interface Multimap<K,V>
      Specified by:
      collectKeyMultiValues in interface OrderedIterableMultimap<K,V>
      Parameters:
      keyFunction - Function to use transformation to get the key
      valueFunction - Function to use transformation to get the values
      Returns:
      a new Multimap, which contains elements as a result of the transformation

    • collectValues

      <V2> ListMultimap<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>
      Specified by:
      collectValues in interface ReversibleIterableMultimap<K,V>
      Parameters:
      function - a Function to use for transformation
      Returns:
      Multimap, which contains elements as a result of the transformation