Package org.eclipse.collections.api.map

Interface MutableOrderedMap<K,​V>

    • Method Detail

      • flipUniqueValues

        MutableOrderedMap<V,​K> flipUniqueValues()
        Description copied from interface: MapIterable
        Return the MapIterable that is obtained by flipping the direction of this map and making the associations from value to key. 
             MapIterable<Integer, String> map = this.newMapWithKeysValues(1, "1", 2, "2", 3, "3");
     MapIterable<String, Integer> result = map.flipUniqueValues();
     Assert.assertTrue(result.equals(UnifiedMap.newWithKeysValues("1", 1, "2", 2, "3", 3)));
        Specified by:
        flipUniqueValues in interface MapIterable<K,​V>
        Specified by:
        flipUniqueValues in interface MutableMapIterable<K,​V>
        Specified by:
        flipUniqueValues in interface OrderedMap<K,​V>

      • flip

        MutableListMultimap<V,​K> flip()
        Description copied from interface: MapIterable
        Given a map from Domain -> Range return a multimap from Range -> Domain. We chose the name 'flip' rather than 'invert' or 'transpose' since this method does not have the property of applying twice returns the original.

        Since the keys in the input are unique, the values in the output are unique, so the return type should be a SetMultimap. However, since SetMultimap and SortedSetMultimap don't inherit from one another, SetMultimap here does not allow SortedMapIterable to have a SortedSetMultimap return. Thus, we compromise and call this Multimap, even though all implementations will be a SetMultimap or SortedSetMultimap.

        Specified by:
        flip in interface MapIterable<K,​V>
        Specified by:
        flip in interface MutableMapIterable<K,​V>
        Specified by:
        flip in interface OrderedMap<K,​V>

      • select

        MutableOrderedMap<K,​V> select​(Predicate2<? super K,​? super V> predicate)
        Description copied from interface: MapIterable
        For each key and value of the map the predicate is evaluated, if the result of the evaluation is true, that key and value are returned in a new map. 
         MapIterable<City, Person> selected =
     peopleByCity.select((city, person) -> city.getName().equals("Anytown") && person.getLastName().equals("Smith"));
        Specified by:
        select in interface MapIterable<K,​V>
        Specified by:
        select in interface MutableMapIterable<K,​V>
        Specified by:
        select in interface OrderedMap<K,​V>

      • reject

        MutableOrderedMap<K,​V> reject​(Predicate2<? super K,​? super V> predicate)
        Description copied from interface: MapIterable
        For each key and value of the map the predicate is evaluated, if the result of the evaluation is false, that key and value are returned in a new map. 
         MapIterable<City, Person> rejected =
     peopleByCity.reject((city, person) -> city.getName().equals("Anytown") && person.getLastName().equals("Smith"));
        Specified by:
        reject in interface MapIterable<K,​V>
        Specified by:
        reject in interface MutableMapIterable<K,​V>
        Specified by:
        reject in interface OrderedMap<K,​V>

      • collect

        <K2,​V2> MutableOrderedMap<K2,​V2> collect​(Function2<? super K,​? super V,​Pair<K2,​V2>> function)
        Description copied from interface: MapIterable
        For each key and value of the map the function is evaluated. The results of these evaluations are returned in a new map. The map returned will use the values projected from the function rather than the original values. 
         MapIterable<String, String> collected =
     peopleByCity.collect((City city, Person person) -> Pair.of(city.getCountry(), person.getAddress().getCity()));
        Specified by:
        collect in interface MapIterable<K,​V>
        Specified by:
        collect in interface MutableMapIterable<K,​V>
        Specified by:
        collect in interface OrderedMap<K,​V>

      • collectValues

        <R> MutableOrderedMap<K,​R> collectValues​(Function2<? super K,​? super V,​? extends R> function)
        Description copied from interface: MapIterable
        For each key and value of the map the function is evaluated. The results of these evaluations are returned in a new map. The map returned will use the values projected from the function rather than the original values. 
         MapIterable<City, String> collected =
     peopleByCity.collectValues((City city, Person person) -> person.getFirstName() + " " + person.getLastName());
        Specified by:
        collectValues in interface MapIterable<K,​V>
        Specified by:
        collectValues in interface MutableMapIterable<K,​V>
        Specified by:
        collectValues in interface OrderedMap<K,​V>

      • take

        MutableOrderedMap<K,​V> take​(int count)
        Description copied from interface: ReversibleIterable
        Returns the first count elements of the iterable or all the elements in the iterable if count is greater than the length of the iterable.
        Specified by:
        take in interface OrderedMap<K,​V>
        Specified by:
        take in interface ReversibleIterable<K>
        Parameters:
        count - the number of items to take.

      • drop

        MutableOrderedMap<K,​V> drop​(int count)
        Description copied from interface: ReversibleIterable
        Returns an iterable after skipping the first count elements or an empty iterable if the count is greater than the length of the iterable.
        Specified by:
        drop in interface OrderedMap<K,​V>
        Specified by:
        drop in interface ReversibleIterable<K>
        Parameters:
        count - the number of items to drop.

      • reject

        MutableList<V> reject​(Predicate<? super V> predicate)
        Description copied from interface: RichIterable
        Returns all elements of the source collection that return false when evaluating of the predicate. This method is also sometimes called filterNot and is the equivalent of calling iterable.select(Predicates.not(predicate)).

        Example using a Java 8 lambda expression: 

         RichIterable<Person> rejected =
     people.reject(person -> person.person.getLastName().equals("Smith"));
        Specified by:
        reject in interface MutableMapIterable<K,​V>
        Specified by:
        reject in interface OrderedIterable<K>
        Specified by:
        reject in interface OrderedMap<K,​V>
        Specified by:
        reject in interface ReversibleIterable<K>
        Specified by:
        reject in interface RichIterable<K>
        Parameters:
        predicate - a Predicate to use as the reject criteria
        Returns:
        a RichIterable that contains elements that cause Predicate.accept(Object) method to evaluate to false

      • zip

        <S> MutableList<Pair<V,​S>> zip​(Iterable<S> that)
        Description copied from interface: RichIterable
        Returns a RichIterable formed from this RichIterable and another RichIterable by combining corresponding elements in pairs. If one of the two RichIterables is longer than the other, its remaining elements are ignored.
        Specified by:
        zip in interface MutableMapIterable<K,​V>
        Specified by:
        zip in interface OrderedIterable<K>
        Specified by:
        zip in interface OrderedMap<K,​V>
        Specified by:
        zip in interface ReversibleIterable<K>
        Specified by:
        zip in interface RichIterable<K>
        Type Parameters:
        S - the type of the second half of the returned pairs
        Parameters:
        that - The RichIterable providing the second half of each result pair
        Returns:
        A new RichIterable containing pairs consisting of corresponding elements of this RichIterable and that. The length of the returned RichIterable is the minimum of the lengths of this RichIterable and that.

      • collect

        <VV> MutableList<VV> collect​(Function<? super V,​? extends VV> function)
        Description copied from interface: RichIterable
        Returns a new collection with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

        Example using a Java 8 lambda expression: 

         RichIterable<String> names =
     people.collect(person -> person.getFirstName() + " " + person.getLastName());
        Specified by:
        collect in interface OrderedIterable<K>
        Specified by:
        collect in interface OrderedMap<K,​V>
        Specified by:
        collect in interface ReversibleIterable<K>
        Specified by:
        collect in interface RichIterable<K>

      • collectIf

        <V1> MutableList<V1> collectIf​(Predicate<? super V> predicate,
                               Function<? super V,​? extends V1> function)
        Description copied from interface: RichIterable
        Returns a new collection with the results of applying the specified function on each element of the source collection, but only for those elements which return true upon evaluation of the predicate. This is the optimized equivalent of calling iterable.select(predicate).collect(function).

        Example using a Java 8 lambda and method reference: 

         RichIterable<String> strings = Lists.mutable.with(1, 2, 3).collectIf(e -> e != null, Object::toString);

        Example using Predicates factory: 

         RichIterable<String> strings = Lists.mutable.with(1, 2, 3).collectIf(Predicates.notNull(), Functions.getToString());
        Specified by:
        collectIf in interface OrderedIterable<K>
        Specified by:
        collectIf in interface OrderedMap<K,​V>
        Specified by:
        collectIf in interface ReversibleIterable<K>
        Specified by:
        collectIf in interface RichIterable<K>

      • flatCollect

        <V1> MutableList<V1> flatCollect​(Function<? super V,​? extends Iterable<V1>> function)
        Description copied from interface: RichIterable
        flatCollect is a special case of RichIterable.collect(Function). With collect, when the Function returns a collection, the result is a collection of collections. flatCollect outputs a single "flattened" collection instead. This method is commonly called flatMap.

        Consider the following example where we have a Person class, and each Person has a list of Address objects. Take the following Function: 

         Function<Person, List<Address>> addressFunction = Person::getAddresses;
 RichIterable<Person> people = ...;
        Using collect returns a collection of collections of addresses. 
         RichIterable<List<Address>> addresses = people.collect(addressFunction);
        Using flatCollect returns a single flattened list of addresses. 
         RichIterable<Address> addresses = people.flatCollect(addressFunction);
        Specified by:
        flatCollect in interface OrderedIterable<K>
        Specified by:
        flatCollect in interface OrderedMap<K,​V>
        Specified by:
        flatCollect in interface ReversibleIterable<K>
        Specified by:
        flatCollect in interface RichIterable<K>
        Parameters:
        function - The Function to apply
        Returns:
        a new flattened collection produced by applying the given function

      • groupBy

        <V1> MutableListMultimap<V1,​V> groupBy​(Function<? super V,​? extends V1> function)
        Description copied from interface: RichIterable
        For each element of the iterable, the function is evaluated and the results of these evaluations are collected into a new multimap, where the transformed value is the key and the original values are added to the same (or similar) species of collection as the source iterable.

        Example using a Java 8 method reference: 

         Multimap<String, Person> peopleByLastName =
     people.groupBy(Person::getLastName);
        Specified by:
        groupBy in interface MutableMapIterable<K,​V>
        Specified by:
        groupBy in interface OrderedIterable<K>
        Specified by:
        groupBy in interface OrderedMap<K,​V>
        Specified by:
        groupBy in interface ReversibleIterable<K>
        Specified by:
        groupBy in interface RichIterable<K>

      • withKeyValue

        MutableOrderedMap<K,​V> withKeyValue​(K key,
                                          V value)
        Description copied from interface: MutableMapIterable
        This method allows mutable, fixed size, and immutable maps the ability to add elements to their existing elements. In order to support fixed size maps, a new instance of a map would have to be returned including the keys and values of the original plus the additional key and value. In the case of mutable maps, the original map is modified and then returned. In order to use this method properly with mutable and fixed size maps the following approach must be taken: 
         map = map.withKeyValue("new key", "new value");
        In the case of FixedSizeMap, a new instance will be returned by withKeyValue, and any variables that previously referenced the original map will need to be redirected to reference the new instance. In the case of a FastMap or UnifiedMap, you will be replacing the reference to map with map, since FastMap and UnifiedMap will both return "this" after calling put on themselves.
        Specified by:
        withKeyValue in interface MutableMapIterable<K,​V>
        See Also:
        Map.put(Object, Object)

      • withAllKeyValues

        MutableOrderedMap<K,​V> withAllKeyValues​(Iterable<? extends Pair<? extends K,​? extends V>> keyValues)
        Description copied from interface: MutableMapIterable
        This method allows mutable, fixed size, and immutable maps the ability to add elements to their existing elements. In order to support fixed size maps, a new instance of a map would have to be returned including the keys and values of the original plus all the additional keys and values. In the case of mutable maps, the original map is modified and then returned. In order to use this method properly with mutable and fixed size maps the following approach must be taken: 
         map = map.withAllKeyValues(FastList.newListWith(PairImpl.of("new key", "new value")));
        In the case of FixedSizeMap, a new instance will be returned by withAllKeyValues, and any variables that previously referenced the original map will need to be redirected to reference the new instance. In the case of a FastMap or UnifiedMap, you will be replacing the reference to map with map, since FastMap and UnifiedMap will both return "this" after calling put on themselves.
        Specified by:
        withAllKeyValues in interface MutableMapIterable<K,​V>
        See Also:
        Map.put(Object, Object)

      • withoutKey

        MutableOrderedMap<K,​V> withoutKey​(K key)
        Description copied from interface: MutableMapIterable
        This method allows mutable, fixed size, and immutable maps the ability to remove elements from their existing elements. In order to support fixed size maps, a new instance of a map would have to be returned including the keys and values of the original minus the key and value to be removed. In the case of mutable maps, the original map is modified and then returned. In order to use this method properly with mutable and fixed size maps the following approach must be taken: 
         map = map.withoutKey("key");
        In the case of FixedSizeMap, a new instance will be returned by withoutKey, and any variables that previously referenced the original map will need to be redirected to reference the new instance. In the case of a FastMap or UnifiedMap, you will be replacing the reference to map with map, since FastMap and UnifiedMap will both return "this" after calling remove on themselves.
        Specified by:
        withoutKey in interface MutableMapIterable<K,​V>
        See Also:
        Map.remove(Object)

      • withoutAllKeys

        MutableOrderedMap<K,​V> withoutAllKeys​(Iterable<? extends K> keys)
        Description copied from interface: MutableMapIterable
        This method allows mutable, fixed size, and immutable maps the ability to remove elements from their existing elements. In order to support fixed size maps, a new instance of a map would have to be returned including the keys and values of the original minus all the keys and values to be removed. In the case of mutable maps, the original map is modified and then returned. In order to use this method properly with mutable and fixed size maps the following approach must be taken: 
         map = map.withoutAllKeys(FastList.newListWith("key1", "key2"));
        In the case of FixedSizeMap, a new instance will be returned by withoutAllKeys, and any variables that previously referenced the original map will need to be redirected to reference the new instance. In the case of a FastMap or UnifiedMap, you will be replacing the reference to map with map, since FastMap and UnifiedMap will both return "this" after calling remove on themselves.
        Specified by:
        withoutAllKeys in interface MutableMapIterable<K,​V>
        See Also:
        Map.remove(Object)

      • asUnmodifiable

        MutableOrderedMap<K,​V> asUnmodifiable()
        Description copied from interface: MutableMapIterable
        Returns an unmodifiable view of this map. This is the equivalent of using Collections.unmodifiableMap(this) only with a return type that supports the full iteration protocols available on MutableMapIterable. Methods which would mutate the underlying map will throw UnsupportedOperationExceptions.
        Specified by:
        asUnmodifiable in interface MutableMapIterable<K,​V>
        Returns:
        an unmodifiable view of this map.
        See Also:
        Collections.unmodifiableMap(Map)