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

Class SynchronizedMutableMap<K,​V>

java.lang.Object
org.eclipse.collections.impl.collection.AbstractSynchronizedRichIterable<V>
org.eclipse.collections.impl.map.AbstractSynchronizedMapIterable<K,​V>
org.eclipse.collections.impl.map.mutable.SynchronizedMutableMap<K,​V>
All Implemented Interfaces:
Serializable, Cloneable, Iterable<V>, Map<K,​V>, InternalIterable<V>, MapIterable<K,​V>, MutableMap<K,​V>, MutableMapIterable<K,​V>, UnsortedMapIterable<K,​V>, RichIterable<V>
public class SynchronizedMutableMap<K,​V>
extends AbstractSynchronizedMapIterable<K,​V>
implements MutableMap<K,​V>, Serializable
A synchronized view of a MutableMap. It is imperative that the user manually synchronize on the collection when iterating over it using the standard JDK iterator or JDK 5 for loop, as per Collections.synchronizedCollection(Collection).
See Also:
MutableMap.asSynchronized(), Serialized Form

  • Constructor Details

  • Method Details

    • of

      public static <K,​ V,​ M extends Map<K,​ V>> SynchronizedMutableMap<K,​V> of​(M map)
      This method will take a MutableMap and wrap it directly in a SynchronizedMutableMap. It will take any other non-Eclipse-Collections map and first adapt it will a MapAdapter, and then return a SynchronizedMutableMap that wraps the adapter.

    • of

      public static <K,​ V,​ M extends Map<K,​ V>> SynchronizedMutableMap<K,​V> of​(M map, Object lock)
      This method will take a MutableMap and wrap it directly in a SynchronizedMutableMap. It will take any other non-Eclipse-Collections map and first adapt it will a MapAdapter, and then return a SynchronizedMutableMap that wraps the adapter. Additionally, a developer specifies which lock to use with the collection.

    • withKeyValue

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

    • withMap

      public MutableMap<K,​V> withMap​(Map<? extends K,​? extends V> map)
      Description copied from interface: MutableMapIterable
      Similar to Map.putAll(Map), but returns this instead of void
      Specified by:
      withMap in interface MutableMap<K,​V>
      Specified by:
      withMap in interface MutableMapIterable<K,​V>
      See Also:
      Map.putAll(Map)

    • withAllKeyValueArguments

      public MutableMap<K,​V> withAllKeyValueArguments​(Pair<? extends K,​? extends V>... keyValuePairs)
      Description copied from interface: MutableMapIterable
      Convenience var-args version of withAllKeyValues
      Specified by:
      withAllKeyValueArguments in interface MutableMap<K,​V>
      Specified by:
      withAllKeyValueArguments in interface MutableMapIterable<K,​V>
      See Also:
      MutableMapIterable.withAllKeyValues(Iterable)

    • withAllKeyValues

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

    • withoutKey

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

    • withoutAllKeys

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

    • newEmpty

      public MutableMap<K,​V> newEmpty()
      Description copied from interface: MutableMapIterable
      Creates a new instance of the same type, using the default capacity and growth parameters.
      Specified by:
      newEmpty in interface MutableMap<K,​V>
      Specified by:
      newEmpty in interface MutableMapIterable<K,​V>

    • clone

      public MutableMap<K,​V> clone()
      Specified by:
      clone in interface MutableMap<K,​V>

    • collectKeysAndValues

      public <E> MutableMap<K,​V> collectKeysAndValues​(Iterable<E> iterable, Function<? super E,​? extends K> keyFunction, Function<? super E,​? extends V> function)
      Description copied from interface: MutableMap
      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 its value replaced by that in map.
      Specified by:
      collectKeysAndValues in interface MutableMap<K,​V>

    • select

      public MutableMap<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 MutableMap<K,​V>
      Specified by:
      select in interface MutableMapIterable<K,​V>
      Specified by:
      select in interface UnsortedMapIterable<K,​V>

    • reject

      public MutableMap<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 MutableMap<K,​V>
      Specified by:
      reject in interface MutableMapIterable<K,​V>
      Specified by:
      reject in interface UnsortedMapIterable<K,​V>

    • collect

      public <K2,​ V2> MutableMap<K2,​V2> collect​(Function2<? super K,​? super V,​Pair<K2,​V2>> pairFunction)
      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 MutableMap<K,​V>
      Specified by:
      collect in interface MutableMapIterable<K,​V>
      Specified by:
      collect in interface UnsortedMapIterable<K,​V>

    • collectValues

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

    • tap

      public MutableMap<K,​V> tap​(Procedure<? super V> procedure)
      Description copied from interface: RichIterable
      Executes the Procedure for each element in the iterable and returns this.

      Example using a Java 8 lambda expression: 

       RichIterable<Person> tapped =
     people.tap(person -> LOGGER.info(person.getName()));

      Example using an anonymous inner class: 

       RichIterable<Person> tapped =
     people.tap(new Procedure<Person>()
     {
         public void value(Person person)
         {
             LOGGER.info(person.getName());
         }
     });
      Specified by:
      tap in interface MapIterable<K,​V>
      Specified by:
      tap in interface MutableMap<K,​V>
      Specified by:
      tap in interface MutableMapIterable<K,​V>
      Specified by:
      tap in interface RichIterable<K>
      Specified by:
      tap in interface UnsortedMapIterable<K,​V>
      Overrides:
      tap in class AbstractSynchronizedMapIterable<K,​V>
      See Also:
      RichIterable.each(Procedure), RichIterable.forEach(Procedure)

    • select

      public MutableBag<V> select​(Predicate<? super V> predicate)
      Description copied from interface: RichIterable
      Returns all elements of the source collection that return true when evaluating the predicate. This method is also commonly called filter.

      Example using a Java 8 lambda expression: 

       RichIterable<Person> selected =
     people.select(person -> person.getAddress().getCity().equals("London"));

      Example using an anonymous inner class: 

       RichIterable<Person> selected =
     people.select(new Predicate<Person>()
     {
         public boolean accept(Person person)
         {
             return person.getAddress().getCity().equals("London");
         }
     });
      Specified by:
      select in interface MutableMap<K,​V>
      Specified by:
      select in interface MutableMapIterable<K,​V>
      Specified by:
      select in interface RichIterable<K>
      Specified by:
      select in interface UnsortedMapIterable<K,​V>
      Overrides:
      select in class AbstractSynchronizedMapIterable<K,​V>

    • selectWith

      public <P> MutableBag<V> selectWith​(Predicate2<? super V,​? super P> predicate, P parameter)
      Description copied from interface: RichIterable
      Similar to RichIterable.select(Predicate), except with an evaluation parameter for the second generic argument in Predicate2.

      E.g. return a Collection of Person elements where the person has an age greater than or equal to 18 years

      Example using a Java 8 lambda expression: 

       RichIterable<Person> selected =
     people.selectWith((Person person, Integer age) -> person.getAge()>= age, Integer.valueOf(18));

      Example using an anonymous inner class: 

       RichIterable<Person> selected =
     people.selectWith(new Predicate2<Person, Integer>()
     {
         public boolean accept(Person person, Integer age)
         {
             return person.getAge()>= age;
         }
     }, Integer.valueOf(18));
      Specified by:
      selectWith in interface MutableMap<K,​V>
      Specified by:
      selectWith in interface MutableMapIterable<K,​V>
      Specified by:
      selectWith in interface RichIterable<K>
      Specified by:
      selectWith in interface UnsortedMapIterable<K,​V>
      Overrides:
      selectWith in class AbstractSynchronizedMapIterable<K,​V>
      Parameters:
      predicate - a Predicate2 to use as the select criteria
      parameter - a parameter to pass in for evaluation of the second argument P in predicate
      See Also:
      RichIterable.select(Predicate)

    • reject

      public MutableBag<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"));

      Example using an anonymous inner class: 

       RichIterable<Person> rejected =
     people.reject(new Predicate<Person>()
     {
         public boolean accept(Person person)
         {
             return person.person.getLastName().equals("Smith");
         }
     });
      Specified by:
      reject in interface MutableMap<K,​V>
      Specified by:
      reject in interface MutableMapIterable<K,​V>
      Specified by:
      reject in interface RichIterable<K>
      Specified by:
      reject in interface UnsortedMapIterable<K,​V>
      Overrides:
      reject in class AbstractSynchronizedMapIterable<K,​V>
      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

    • rejectWith

      public <P> MutableBag<V> rejectWith​(Predicate2<? super V,​? super P> predicate, P parameter)
      Description copied from interface: RichIterable
      Similar to RichIterable.reject(Predicate), except with an evaluation parameter for the second generic argument in Predicate2.

      E.g. return a Collection of Person elements where the person has an age greater than or equal to 18 years

      Example using a Java 8 lambda expression: 

       RichIterable<Person> rejected =
     people.rejectWith((Person person, Integer age) -> person.getAge() < age, Integer.valueOf(18));

      Example using an anonymous inner class: 

       MutableList<Person> rejected =
     people.rejectWith(new Predicate2<Person, Integer>()
     {
         public boolean accept(Person person, Integer age)
         {
             return person.getAge() < age;
         }
     }, Integer.valueOf(18));
      Specified by:
      rejectWith in interface MutableMap<K,​V>
      Specified by:
      rejectWith in interface MutableMapIterable<K,​V>
      Specified by:
      rejectWith in interface RichIterable<K>
      Specified by:
      rejectWith in interface UnsortedMapIterable<K,​V>
      Overrides:
      rejectWith in class AbstractSynchronizedMapIterable<K,​V>
      Parameters:
      predicate - a Predicate2 to use as the select criteria
      parameter - a parameter to pass in for evaluation of the second argument P in predicate
      See Also:
      RichIterable.select(Predicate)

    • partition

      public PartitionMutableBag<V> partition​(Predicate<? super V> predicate)
      Description copied from interface: RichIterable
      Filters a collection into a PartitionedIterable based on the evaluation of the predicate.

      Example using a Java 8 lambda expression: 

       PartitionIterable<Person> newYorkersAndNonNewYorkers =
     people.partition(person -> person.getAddress().getState().getName().equals("New York"));

      Example using an anonymous inner class: 

       PartitionIterable<Person> newYorkersAndNonNewYorkers =
     people.partition(new Predicate<Person>()
     {
         public boolean accept(Person person)
         {
             return person.getAddress().getState().getName().equals("New York");
         }
     });
      Specified by:
      partition in interface MutableMap<K,​V>
      Specified by:
      partition in interface MutableMapIterable<K,​V>
      Specified by:
      partition in interface RichIterable<K>
      Specified by:
      partition in interface UnsortedMapIterable<K,​V>
      Overrides:
      partition in class AbstractSynchronizedMapIterable<K,​V>

    • zipWithIndex

      @Deprecated public MutableSet<Pair<V,​Integer>> zipWithIndex()
      Deprecated.
      in 6.0. Use OrderedIterable.zipWithIndex() instead.
      Description copied from interface: RichIterable
      Zips this RichIterable with its indices.
      Specified by:
      zipWithIndex in interface MutableMap<K,​V>
      Specified by:
      zipWithIndex in interface MutableMapIterable<K,​V>
      Specified by:
      zipWithIndex in interface RichIterable<K>
      Specified by:
      zipWithIndex in interface UnsortedMapIterable<K,​V>
      Overrides:
      zipWithIndex in class AbstractSynchronizedMapIterable<K,​V>
      Returns:
      A new RichIterable containing pairs consisting of all elements of this RichIterable paired with their index. Indices start at 0.
      See Also:
      RichIterable.zip(Iterable)

    • partitionWith

      public <P> PartitionMutableBag<V> partitionWith​(Predicate2<? super V,​? super P> predicate, P parameter)
      Description copied from interface: RichIterable
      Filters a collection into a PartitionIterable based on the evaluation of the predicate.

      Example using a Java 8 lambda expression: 

       PartitionIterable<Person> newYorkersAndNonNewYorkers =
     people.partitionWith((Person person, String state) -> person.getAddress().getState().getName().equals(state), "New York");

      Example using an anonymous inner class: 

       PartitionIterable<Person> newYorkersAndNonNewYorkers =
     people.partitionWith(new Predicate2<Person, String>()
     {
         public boolean accept(Person person, String state)
         {
             return person.getAddress().getState().getName().equals(state);
         }
     }, "New York");
      Specified by:
      partitionWith in interface MutableMap<K,​V>
      Specified by:
      partitionWith in interface RichIterable<K>
      Specified by:
      partitionWith in interface UnsortedMapIterable<K,​V>
      Overrides:
      partitionWith in class AbstractSynchronizedRichIterable<V>

    • selectInstancesOf

      public <S> MutableBag<S> selectInstancesOf​(Class<S> clazz)
      Description copied from interface: RichIterable
      Returns all elements of the source collection that are instances of the Class clazz. 
       RichIterable<Integer> integers =
     List.mutable.with(new Integer(0), new Long(0L), new Double(0.0)).selectInstancesOf(Integer.class);
      Specified by:
      selectInstancesOf in interface MutableMap<K,​V>
      Specified by:
      selectInstancesOf in interface MutableMapIterable<K,​V>
      Specified by:
      selectInstancesOf in interface RichIterable<K>
      Specified by:
      selectInstancesOf in interface UnsortedMapIterable<K,​V>
      Overrides:
      selectInstancesOf in class AbstractSynchronizedMapIterable<K,​V>

    • collect

      public <A> MutableBag<A> collect​(Function<? super V,​? extends A> 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());

      Example using an anonymous inner class: 

       RichIterable<String> names =
     people.collect(new Function<Person, String>()
     {
         public String valueOf(Person person)
         {
             return person.getFirstName() + " " + person.getLastName();
         }
     });
      Specified by:
      collect in interface MutableMap<K,​V>
      Specified by:
      collect in interface RichIterable<K>
      Specified by:
      collect in interface UnsortedMapIterable<K,​V>
      Overrides:
      collect in class AbstractSynchronizedRichIterable<V>

    • collectBoolean

      public MutableBooleanBag collectBoolean​(BooleanFunction<? super V> booleanFunction)
      Description copied from interface: RichIterable
      Returns a new primitive boolean iterable 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: 

       BooleanIterable licenses =
     people.collectBoolean(person -> person.hasDrivingLicense());

      Example using an anonymous inner class: 

       BooleanIterable licenses =
     people.collectBoolean(new BooleanFunction<Person>()
     {
         public boolean booleanValueOf(Person person)
         {
             return person.hasDrivingLicense();
         }
     });
      Specified by:
      collectBoolean in interface MutableMap<K,​V>
      Specified by:
      collectBoolean in interface RichIterable<K>
      Specified by:
      collectBoolean in interface UnsortedMapIterable<K,​V>
      Overrides:
      collectBoolean in class AbstractSynchronizedRichIterable<V>

    • collectByte

      public MutableByteBag collectByte​(ByteFunction<? super V> byteFunction)
      Description copied from interface: RichIterable
      Returns a new primitive byte iterable 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: 

       ByteIterable bytes =
     people.collectByte(person -> person.getCode());

      Example using an anonymous inner class: 

       ByteIterable bytes =
     people.collectByte(new ByteFunction<Person>()
     {
         public byte byteValueOf(Person person)
         {
             return person.getCode();
         }
     });
      Specified by:
      collectByte in interface MutableMap<K,​V>
      Specified by:
      collectByte in interface RichIterable<K>
      Specified by:
      collectByte in interface UnsortedMapIterable<K,​V>
      Overrides:
      collectByte in class AbstractSynchronizedRichIterable<V>

    • collectChar

      public MutableCharBag collectChar​(CharFunction<? super V> charFunction)
      Description copied from interface: RichIterable
      Returns a new primitive char iterable 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: 

       CharIterable chars =
     people.collectChar(person -> person.getMiddleInitial());

      Example using an anonymous inner class: 

       CharIterable chars =
     people.collectChar(new CharFunction<Person>()
     {
         public char charValueOf(Person person)
         {
             return person.getMiddleInitial();
         }
     });
      Specified by:
      collectChar in interface MutableMap<K,​V>
      Specified by:
      collectChar in interface RichIterable<K>
      Specified by:
      collectChar in interface UnsortedMapIterable<K,​V>
      Overrides:
      collectChar in class AbstractSynchronizedRichIterable<V>

    • collectDouble

      public MutableDoubleBag collectDouble​(DoubleFunction<? super V> doubleFunction)
      Description copied from interface: RichIterable
      Returns a new primitive double iterable 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: 

       DoubleIterable doubles =
     people.collectDouble(person -> person.getMilesFromNorthPole());

      Example using an anonymous inner class: 

       DoubleIterable doubles =
     people.collectDouble(new DoubleFunction<Person>()
     {
         public double doubleValueOf(Person person)
         {
             return person.getMilesFromNorthPole();
         }
     });
      Specified by:
      collectDouble in interface MutableMap<K,​V>
      Specified by:
      collectDouble in interface RichIterable<K>
      Specified by:
      collectDouble in interface UnsortedMapIterable<K,​V>
      Overrides:
      collectDouble in class AbstractSynchronizedRichIterable<V>

    • collectFloat

      public MutableFloatBag collectFloat​(FloatFunction<? super V> floatFunction)
      Description copied from interface: RichIterable
      Returns a new primitive float iterable 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: 

       FloatIterable floats =
     people.collectFloat(person -> person.getHeightInInches());

      Example using an anonymous inner class: 

       FloatIterable floats =
     people.collectFloat(new FloatFunction<Person>()
     {
         public float floatValueOf(Person person)
         {
             return person.getHeightInInches();
         }
     });
      Specified by:
      collectFloat in interface MutableMap<K,​V>
      Specified by:
      collectFloat in interface RichIterable<K>
      Specified by:
      collectFloat in interface UnsortedMapIterable<K,​V>
      Overrides:
      collectFloat in class AbstractSynchronizedRichIterable<V>

    • collectInt

      public MutableIntBag collectInt​(IntFunction<? super V> intFunction)
      Description copied from interface: RichIterable
      Returns a new primitive int iterable 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: 

       IntIterable ints =
     people.collectInt(person -> person.getAge());

      Example using an anonymous inner class: 

       IntIterable ints =
     people.collectInt(new IntFunction<Person>()
     {
         public int intValueOf(Person person)
         {
             return person.getAge();
         }
     });
      Specified by:
      collectInt in interface MutableMap<K,​V>
      Specified by:
      collectInt in interface RichIterable<K>
      Specified by:
      collectInt in interface UnsortedMapIterable<K,​V>
      Overrides:
      collectInt in class AbstractSynchronizedRichIterable<V>

    • collectLong

      public MutableLongBag collectLong​(LongFunction<? super V> longFunction)
      Description copied from interface: RichIterable
      Returns a new primitive long iterable 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: 

       LongIterable longs =
     people.collectLong(person -> person.getGuid());

      Example using an anonymous inner class: 

       LongIterable longs =
     people.collectLong(new LongFunction<Person>()
     {
         public long longValueOf(Person person)
         {
             return person.getGuid();
         }
     });
      Specified by:
      collectLong in interface MutableMap<K,​V>
      Specified by:
      collectLong in interface RichIterable<K>
      Specified by:
      collectLong in interface UnsortedMapIterable<K,​V>
      Overrides:
      collectLong in class AbstractSynchronizedRichIterable<V>

    • collectShort

      public MutableShortBag collectShort​(ShortFunction<? super V> shortFunction)
      Description copied from interface: RichIterable
      Returns a new primitive short iterable 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: 

       ShortIterable shorts =
     people.collectShort(person -> person.getNumberOfJunkMailItemsReceivedPerMonth());

      Example using an anonymous inner class: 

       ShortIterable shorts =
     people.collectShort(new ShortFunction<Person>()
     {
         public short shortValueOf(Person person)
         {
             return person.getNumberOfJunkMailItemsReceivedPerMonth();
         }
     });
      Specified by:
      collectShort in interface MutableMap<K,​V>
      Specified by:
      collectShort in interface RichIterable<K>
      Specified by:
      collectShort in interface UnsortedMapIterable<K,​V>
      Overrides:
      collectShort in class AbstractSynchronizedRichIterable<V>

    • collectWith

      public <P,​ A> MutableBag<A> collectWith​(Function2<? super V,​? super P,​? extends A> function, P parameter)
      Description copied from interface: RichIterable
      Same as RichIterable.collect(Function) with a Function2 and specified parameter which is passed to the block.

      Example using a Java 8 lambda expression: 

       RichIterable<Integer> integers =
     Lists.mutable.with(1, 2, 3).collectWith((each, parameter) -> each + parameter, Integer.valueOf(1));

      Example using an anonymous inner class: 

       Function2<Integer, Integer, Integer> addParameterFunction =
     new Function2<Integer, Integer, Integer>()
     {
         public Integer value(Integer each, Integer parameter)
         {
             return each + parameter;
         }
     };
 RichIterable<Integer> integers =
     Lists.mutable.with(1, 2, 3).collectWith(addParameterFunction, Integer.valueOf(1));
      Specified by:
      collectWith in interface MutableMap<K,​V>
      Specified by:
      collectWith in interface RichIterable<K>
      Specified by:
      collectWith in interface UnsortedMapIterable<K,​V>
      Overrides:
      collectWith in class AbstractSynchronizedRichIterable<V>
      Parameters:
      function - A Function2 to use as the collect transformation function
      parameter - A parameter to pass in for evaluation of the second argument P in function
      Returns:
      A new RichIterable that contains the transformed elements returned by Function2.value(Object, Object)
      See Also:
      RichIterable.collect(Function)

    • collectIf

      public <A> MutableBag<A> collectIf​(Predicate<? super V> predicate, Function<? super V,​? extends A> 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 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 MutableMap<K,​V>
      Specified by:
      collectIf in interface RichIterable<K>
      Specified by:
      collectIf in interface UnsortedMapIterable<K,​V>
      Overrides:
      collectIf in class AbstractSynchronizedRichIterable<V>

    • flatCollect

      public <A> MutableBag<A> flatCollect​(Function<? super V,​? extends Iterable<A>> 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 MutableMap<K,​V>
      Specified by:
      flatCollect in interface RichIterable<K>
      Specified by:
      flatCollect in interface UnsortedMapIterable<K,​V>
      Overrides:
      flatCollect in class AbstractSynchronizedRichIterable<V>
      Parameters:
      function - The Function to apply
      Returns:
      a new flattened collection produced by applying the given function

    • groupBy

      public <KK> MutableBagMultimap<KK,​V> groupBy​(Function<? super V,​? extends KK> 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);

      Example using an anonymous inner class: 

       Multimap<String, Person> peopleByLastName =
     people.groupBy(new Function<Person, String>()
     {
         public String valueOf(Person person)
         {
             return person.getLastName();
         }
     });
      Specified by:
      groupBy in interface MutableMap<K,​V>
      Specified by:
      groupBy in interface MutableMapIterable<K,​V>
      Specified by:
      groupBy in interface RichIterable<K>
      Specified by:
      groupBy in interface UnsortedMapIterable<K,​V>
      Overrides:
      groupBy in class AbstractSynchronizedMapIterable<K,​V>

    • groupByEach

      public <KK> MutableBagMultimap<KK,​V> groupByEach​(Function<? super V,​? extends Iterable<KK>> function)
      Description copied from interface: RichIterable
      Similar to RichIterable.groupBy(Function), except the result of evaluating function will return a collection of keys for each value.
      Specified by:
      groupByEach in interface MutableMap<K,​V>
      Specified by:
      groupByEach in interface MutableMapIterable<K,​V>
      Specified by:
      groupByEach in interface RichIterable<K>
      Specified by:
      groupByEach in interface UnsortedMapIterable<K,​V>
      Overrides:
      groupByEach in class AbstractSynchronizedMapIterable<K,​V>

    • zip

      @Deprecated public <S> MutableBag<Pair<V,​S>> zip​(Iterable<S> that)
      Deprecated.
      in 6.0. Use OrderedIterable.zip(Iterable) instead.
      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 MutableMap<K,​V>
      Specified by:
      zip in interface MutableMapIterable<K,​V>
      Specified by:
      zip in interface RichIterable<K>
      Specified by:
      zip in interface UnsortedMapIterable<K,​V>
      Overrides:
      zip in class AbstractSynchronizedMapIterable<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.

    • groupByUniqueKey

      public <VV> MutableMap<VV,​V> groupByUniqueKey​(Function<? super V,​? extends VV> function)
      Description copied from interface: RichIterable
      For each element of the iterable, the function is evaluated and he results of these evaluations are collected into a new map, where the transformed value is the key. The generated keys must each be unique, or else an exception is thrown.
      Specified by:
      groupByUniqueKey in interface MutableMap<K,​V>
      Specified by:
      groupByUniqueKey in interface MutableMapIterable<K,​V>
      Specified by:
      groupByUniqueKey in interface RichIterable<K>
      Specified by:
      groupByUniqueKey in interface UnsortedMapIterable<K,​V>
      Overrides:
      groupByUniqueKey in class AbstractSynchronizedMapIterable<K,​V>
      See Also:
      RichIterable.groupBy(Function)

    • flipUniqueValues

      public MutableMap<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 MutableMap<K,​V>
      Specified by:
      flipUniqueValues in interface MutableMapIterable<K,​V>
      Specified by:
      flipUniqueValues in interface UnsortedMapIterable<K,​V>

    • flip

      public MutableSetMultimap<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 MutableMap<K,​V>
      Specified by:
      flip in interface MutableMapIterable<K,​V>
      Specified by:
      flip in interface UnsortedMapIterable<K,​V>

    • keySet

      public Set<K> keySet()
      Specified by:
      keySet in interface Map<K,​V>

    • values

      public Collection<V> values()
      Specified by:
      values in interface Map<K,​V>

    • entrySet

      public Set<Map.Entry<K,​V>> entrySet()
      Specified by:
      entrySet in interface Map<K,​V>

    • keysView

      public RichIterable<K> keysView()
      Description copied from interface: MapIterable
      Returns an unmodifiable lazy iterable wrapped around the keySet for the map.
      Specified by:
      keysView in interface MapIterable<K,​V>

    • valuesView

      public RichIterable<V> valuesView()
      Description copied from interface: MapIterable
      Returns an unmodifiable lazy iterable wrapped around the values for the map.
      Specified by:
      valuesView in interface MapIterable<K,​V>

    • asUnmodifiable

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

    • asSynchronized

      public MutableMap<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 MutableMap<K,​V>
      Specified by:
      asSynchronized in interface MutableMapIterable<K,​V>
      See Also:
      Collections.synchronizedMap(Map)

    • toImmutable

      public ImmutableMap<K,​V> toImmutable()
      Description copied from interface: MutableMapIterable
      Returns an immutable copy of this map. If the map is immutable, it returns itself.
      Specified by:
      toImmutable in interface MapIterable<K,​V>
      Specified by:
      toImmutable in interface MutableMapIterable<K,​V>
      Specified by:
      toImmutable in interface UnsortedMapIterable<K,​V>