Package org.eclipse.collections.impl.bimap.mutable

Class SynchronizedBiMap<K,​V>

    • Constructor Detail

      • SynchronizedBiMap

        protected SynchronizedBiMap​(MutableBiMap<K,​V> delegate)

      • SynchronizedBiMap

        protected SynchronizedBiMap​(MutableBiMap<K,​V> delegate,
                            java.lang.Object lock)

    • Method Detail

      • of

        public static <K,​V> SynchronizedBiMap<K,​V> of​(MutableBiMap<K,​V> map)
        This method will take a MutableBiMap and wrap it directly in a SynchronizedBiMap.

      • asSynchronized

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

      • asUnmodifiable

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

      • select

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

      • reject

        public MutableSet<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 BiMap<K,​V>
        Specified by:
        reject in interface MutableBiMap<K,​V>
        Specified by:
        reject in interface MutableMapIterable<K,​V>
        Specified by:
        reject in interface RichIterable<K>
        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

      • reject

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

      • groupBy

        public <V1> MutableSetMultimap<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 BiMap<K,​V>
        Specified by:
        groupBy in interface MutableBiMap<K,​V>
        Specified by:
        groupBy in interface MutableMapIterable<K,​V>
        Specified by:
        groupBy in interface RichIterable<K>
        Overrides:
        groupBy in class AbstractSynchronizedMapIterable<K,​V>

      • aggregateBy

        public <K1,​V1,​V2> MutableMap<K1,​V2> aggregateBy​(Function<? super K,​? extends K1> keyFunction,
                                                                  Function<? super V,​? extends V1> valueFunction,
                                                                  Function0<? extends V2> zeroValueFactory,
                                                                  Function2<? super V2,​? super V1,​? extends V2> nonMutatingAggregator)
        Description copied from interface: MapIterable
        Applies an aggregate function over the map grouping results into a map based on the specific key and value groupBy functions. Aggregate results are allowed to be immutable as they will be replaced in place in the map. A second function specifies the initial "zero" aggregate value to work with. 
         MapIterable<String, Interval> map = Maps.mutable.with("oneToFive", Interval.fromTo(1, 5), "sixToNine", Interval.fromTo(6, 9));

 MapIterable<String, Long> result = map.aggregateBy(
         eachKey -> {
             return eachKey.equals("oneToFive")  ? "lessThanSix" : "greaterOrEqualsToSix";
         },
         each -> each.sumOfInt(Integer::intValue),
         () -> 0L,
         (argument1, argument2) -> argument1 + argument2);

 MapIterable<String, Long> expected =
         Maps.mutable.with("lessThanSix", Interval.fromTo(1, 5).sumOfInt(Integer::intValue),
                 "greaterOrEqualsToSix", Interval.fromTo(6, 9).sumOfInt(Integer::intValue));
 Assert.assertEquals(expected, result);
        Specified by:
        aggregateBy in interface MapIterable<K,​V>
        Specified by:
        aggregateBy in interface MutableBiMap<K,​V>
        Specified by:
        aggregateBy in interface MutableMapIterable<K,​V>
        Overrides:
        aggregateBy in class AbstractSynchronizedMapIterable<K,​V>
        Since:
        11.0

      • 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 BiMap<K,​V>
        Specified by:
        flip in interface MapIterable<K,​V>
        Specified by:
        flip in interface MutableBiMap<K,​V>
        Specified by:
        flip in interface MutableMapIterable<K,​V>

      • inverse

        public MutableBiMap<V,​K> inverse()
        Description copied from interface: BiMap
        Returns an inversed view of this BiMap, where the associations are in the direction of this bimap's values to keys.
        Specified by:
        inverse in interface BiMap<K,​V>
        Specified by:
        inverse in interface MutableBiMap<K,​V>

      • flipUniqueValues

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

      • zip

        @Deprecated
public <S> MutableSet<Pair<V,​S>> zip​(java.lang.Iterable<S> that)
        Deprecated.
        in 8.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 BiMap<K,​V>
        Specified by:
        zip in interface MutableBiMap<K,​V>
        Specified by:
        zip in interface MutableMapIterable<K,​V>
        Specified by:
        zip in interface RichIterable<K>
        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.

      • withKeyValue

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

      • withAllKeyValues

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

      • withoutKey

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

      • withoutAllKeys

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

      • keySet

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

      • values

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

      • entrySet

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

      • writeReplace

        protected java.lang.Object writeReplace()