Package org.eclipse.collections.impl.map.sorted.mutable

Class AbstractMutableSortedMap<K,​V>

    • Constructor Detail

      • AbstractMutableSortedMap

        public AbstractMutableSortedMap()

    • Method Detail

      • withKeyValue

        public MutableSortedMap<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>
        Specified by:
        withKeyValue in interface MutableSortedMap<K,​V>
        See Also:
        Map.put(Object, Object)

      • withAllKeyValues

        public MutableSortedMap<K,​V> withAllKeyValues​(java.lang.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>
        Specified by:
        withAllKeyValues in interface MutableSortedMap<K,​V>
        See Also:
        Map.put(Object, Object)

      • withoutKey

        public MutableSortedMap<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>
        Specified by:
        withoutKey in interface MutableSortedMap<K,​V>
        See Also:
        Map.remove(Object)

      • withoutAllKeys

        public MutableSortedMap<K,​V> withoutAllKeys​(java.lang.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>
        Specified by:
        withoutAllKeys in interface MutableSortedMap<K,​V>
        See Also:
        Map.remove(Object)

      • asUnmodifiable

        public MutableSortedMap<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>
        Specified by:
        asUnmodifiable in interface MutableSortedMap<K,​V>
        Returns:
        an unmodifiable view of this map.
        See Also:
        Collections.unmodifiableMap(Map)

      • asSynchronized

        public MutableSortedMap<K,​V> asSynchronized()
        Description copied from interface: MutableMapIterable
        Returns a synchronized wrapper backed by this map. This is the equivalent of calling Collections.synchronizedMap(this) only with the more feature rich return type of MutableMapIterable.

        The preferred way of iterating over a synchronized map is to use the forEachKey(), forEachValue() and forEachKeyValue() methods which are properly synchronized internally. 

          MutableMap synchedMap = map.asSynchronized();

  synchedMap.forEachKey(key -> ... );
  synchedMap.forEachValue(value -> ... );
  synchedMap.forEachKeyValue((key, value) -> ... );

        If you want to iterate imperatively over the keySet(), values(), or entrySet(), you will need to protect the iteration by wrapping the code in a synchronized block on the map.

        Specified by:
        asSynchronized in interface MutableMapIterable<K,​V>
        Specified by:
        asSynchronized in interface MutableSortedMap<K,​V>
        See Also:
        Collections.synchronizedMap(Map)

      • flip

        public MutableSortedSetMultimap<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 MutableSortedMap<K,​V>
        Specified by:
        flip in interface SortedMapIterable<K,​V>

      • collectKeysAndValues

        public <E> MutableSortedMap<K,​V> collectKeysAndValues​(java.lang.Iterable<E> iterable,
                                                            Function<? super E,​? extends K> keyFunction,
                                                            Function<? super E,​? extends V> valueFunction)
        Description copied from interface: MutableSortedMap
        Adds all the entries derived from iterable to this. The key and value for each entry is determined by applying the keyFunction and valueFunction to each item in collection. Any entry in map that has the same key as an entry in this will have it's value replaced by that in map.
        Specified by:
        collectKeysAndValues in interface MutableSortedMap<K,​V>

      • collectValues

        public <R> MutableSortedMap<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 MutableSortedMap<K,​V>
        Specified by:
        collectValues in interface SortedMapIterable<K,​V>

      • select

        public MutableSortedMap<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 MutableSortedMap<K,​V>
        Specified by:
        select in interface SortedMapIterable<K,​V>

      • reject

        public MutableSortedMap<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 MutableSortedMap<K,​V>
        Specified by:
        reject in interface SortedMapIterable<K,​V>

      • collectIf

        public <R> MutableList<R> collectIf​(Predicate<? super V> predicate,
                                    Function<? super V,​? extends R> 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 MutableSortedMap<K,​V>
        Specified by:
        collectIf in interface OrderedIterable<K>
        Specified by:
        collectIf in interface ReversibleIterable<K>
        Specified by:
        collectIf in interface RichIterable<K>
        Specified by:
        collectIf in interface SortedMapIterable<K,​V>

      • flatCollect

        public <R> MutableList<R> flatCollect​(Function<? super V,​? extends java.lang.Iterable<R>> 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 MutableSortedMap<K,​V>
        Specified by:
        flatCollect in interface OrderedIterable<K>
        Specified by:
        flatCollect in interface ReversibleIterable<K>
        Specified by:
        flatCollect in interface RichIterable<K>
        Specified by:
        flatCollect in interface SortedMapIterable<K,​V>
        Parameters:
        function - The Function to apply
        Returns:
        a new flattened collection produced by applying the given function

      • zip

        public <S> MutableList<Pair<V,​S>> zip​(java.lang.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 MutableSortedMap<K,​V>
        Specified by:
        zip in interface OrderedIterable<K>
        Specified by:
        zip in interface ReversibleIterable<K>
        Specified by:
        zip in interface RichIterable<K>
        Specified by:
        zip in interface SortedMapIterable<K,​V>
        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.

      • detectLastIndex

        public int detectLastIndex​(Predicate<? super V> predicate)
        Description copied from interface: ReversibleIterable
        Returns the index of the last element of the ReversibleIterable for which the predicate evaluates to true. Returns -1 if no element evaluates true for the predicate.
        Specified by:
        detectLastIndex in interface ReversibleIterable<K>

      • corresponds

        public <S> boolean corresponds​(OrderedIterable<S> other,
                               Predicate2<? super V,​? super S> predicate)
        Description copied from interface: OrderedIterable
        Returns true if both OrderedIterables have the same length and predicate returns true for all corresponding elements e1 of this OrderedIterable and e2 of other. The predicate is evaluated for each element at the same position of each OrderedIterable in a forward iteration order. This is a short circuit pattern.
        Specified by:
        corresponds in interface OrderedIterable<K>

      • forEach

        public void forEach​(int startIndex,
                    int endIndex,
                    Procedure<? super V> procedure)
        Description copied from interface: OrderedIterable
        Iterates over the section of the iterable covered by the specified inclusive indexes. The indexes are both inclusive. 
        e.g.
 OrderedIterable<Person> people = FastList.newListWith(ted, mary, bob, sally)
 people.forEach(0, 1, person -> LOGGER.info(person.getName()));

        This code would output ted and mary's names.

        Specified by:
        forEach in interface OrderedIterable<K>

      • forEachWithIndex

        public void forEachWithIndex​(int fromIndex,
                             int toIndex,
                             ObjectIntProcedure<? super V> objectIntProcedure)
        Description copied from interface: OrderedIterable
        Iterates over the section of the iterable covered by the specified inclusive indexes. The indexes are both inclusive. 
        e.g.
 OrderedIterable<People> people = FastList.newListWith(ted, mary, bob, sally)
 people.forEachWithIndex(0, 1, (person, index) -> LOGGER.info(person.getName()));

        This code would output ted and mary's names.

        Specified by:
        forEachWithIndex in interface OrderedIterable<K>

      • detectIndex

        public int detectIndex​(Predicate<? super V> predicate)
        Description copied from interface: OrderedIterable
        Returns the index of the first element of the OrderedIterable for which the predicate evaluates to true. Returns -1 if no element evaluates true for the predicate.
        Specified by:
        detectIndex in interface OrderedIterable<K>