Class AbstractImmutableMap<K,​V>

    • Constructor Detail

      • AbstractImmutableMap

        public AbstractImmutableMap()
    • Method Detail

      • iterator

        public java.util.Iterator<V> iterator()
        Specified by:
        iterator in interface java.lang.Iterable<K>
      • putAll

        public void putAll​(java.util.Map<? extends K,​? extends V> map)
        Specified by:
        putAll in interface java.util.Map<K,​V>
      • clear

        public void clear()
        Specified by:
        clear in interface java.util.Map<K,​V>
      • flip

        public ImmutableSetMultimap<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 ImmutableMap<K,​V>
        Specified by:
        flip in interface ImmutableMapIterable<K,​V>
        Specified by:
        flip in interface MapIterable<K,​V>
        Specified by:
        flip in interface UnsortedMapIterable<K,​V>
      • entrySet

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

        public V put​(K key,
                     V value)
        Specified by:
        put in interface java.util.Map<K,​V>
      • remove

        public V remove​(java.lang.Object key)
        Specified by:
        remove in interface java.util.Map<K,​V>
      • collect

        public <K2,​V2> ImmutableMap<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 ImmutableMap<K,​V>
        Specified by:
        collect in interface ImmutableMapIterable<K,​V>
        Specified by:
        collect in interface MapIterable<K,​V>
        Specified by:
        collect in interface UnsortedMapIterable<K,​V>
      • collectValues

        public <R> ImmutableMap<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 ImmutableMap<K,​V>
        Specified by:
        collectValues in interface ImmutableMapIterable<K,​V>
        Specified by:
        collectValues in interface MapIterable<K,​V>
        Specified by:
        collectValues in interface UnsortedMapIterable<K,​V>
      • select

        public ImmutableMap<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 ImmutableMap<K,​V>
        Specified by:
        select in interface ImmutableMapIterable<K,​V>
        Specified by:
        select in interface MapIterable<K,​V>
        Specified by:
        select in interface UnsortedMapIterable<K,​V>
      • reject

        public ImmutableMap<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 ImmutableMap<K,​V>
        Specified by:
        reject in interface ImmutableMapIterable<K,​V>
        Specified by:
        reject in interface MapIterable<K,​V>
        Specified by:
        reject in interface UnsortedMapIterable<K,​V>
      • detect

        public Pair<K,​V> detect​(Predicate2<? super K,​? super V> predicate)
        Description copied from interface: MapIterable
        Return the first key and value of the map for which the predicate evaluates to true when they are given as arguments. The predicate will only be evaluated until such pair is found or until all the keys and values of the map have been used as arguments. That is, there may be keys and values of the map that are never used as arguments to the predicate. The result is null if predicate does not evaluate to true for any key/value combination.
         Pair<City, Person> detected =
             peopleByCity.detect((City city, Person person) -> city.getName().equals("Anytown") && person.getLastName().equals("Smith"));
         
        Specified by:
        detect in interface MapIterable<K,​V>
      • detectOptional

        public java.util.Optional<Pair<K,​V>> detectOptional​(Predicate2<? super K,​? super V> predicate)
        Description copied from interface: MapIterable
        Return the first key and value of the map as an Optional for which the predicate evaluates to true when they are given as arguments. The predicate will only be evaluated until such pair is found or until all the keys and values of the map have been used as arguments. That is, there may be keys and values of the map that are never used as arguments to the predicate.
         Optional<Pair<City, Person>> detected =
             peopleByCity.detectOptional((city, person)
                  -> city.getName().equals("Anytown") && person.getLastName().equals("Smith"));
         
        Specified by:
        detectOptional in interface MapIterable<K,​V>
      • collect

        public <R> ImmutableBag<R> collect​(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. 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 ImmutableMap<K,​V>
        Specified by:
        collect in interface RichIterable<K>
        Specified by:
        collect in interface UnsortedMapIterable<K,​V>
      • collectByte

        public ImmutableByteBag 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());
         
        Specified by:
        collectByte in interface ImmutableMap<K,​V>
        Specified by:
        collectByte in interface RichIterable<K>
        Specified by:
        collectByte in interface UnsortedMapIterable<K,​V>
      • collectChar

        public ImmutableCharBag 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());
         
        Specified by:
        collectChar in interface ImmutableMap<K,​V>
        Specified by:
        collectChar in interface RichIterable<K>
        Specified by:
        collectChar in interface UnsortedMapIterable<K,​V>
      • collectDouble

        public ImmutableDoubleBag 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());
         
        Specified by:
        collectDouble in interface ImmutableMap<K,​V>
        Specified by:
        collectDouble in interface RichIterable<K>
        Specified by:
        collectDouble in interface UnsortedMapIterable<K,​V>
      • collectFloat

        public ImmutableFloatBag 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());
         
        Specified by:
        collectFloat in interface ImmutableMap<K,​V>
        Specified by:
        collectFloat in interface RichIterable<K>
        Specified by:
        collectFloat in interface UnsortedMapIterable<K,​V>
      • collectInt

        public ImmutableIntBag 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());
         
        Specified by:
        collectInt in interface ImmutableMap<K,​V>
        Specified by:
        collectInt in interface RichIterable<K>
        Specified by:
        collectInt in interface UnsortedMapIterable<K,​V>
      • collectLong

        public ImmutableLongBag 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());
         
        Specified by:
        collectLong in interface ImmutableMap<K,​V>
        Specified by:
        collectLong in interface RichIterable<K>
        Specified by:
        collectLong in interface UnsortedMapIterable<K,​V>
      • collectShort

        public ImmutableShortBag 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());
         
        Specified by:
        collectShort in interface ImmutableMap<K,​V>
        Specified by:
        collectShort in interface RichIterable<K>
        Specified by:
        collectShort in interface UnsortedMapIterable<K,​V>
      • collectIf

        public <R> ImmutableBag<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 ImmutableMap<K,​V>
        Specified by:
        collectIf in interface RichIterable<K>
        Specified by:
        collectIf in interface UnsortedMapIterable<K,​V>
      • flatCollect

        public <R> ImmutableBag<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 ImmutableMap<K,​V>
        Specified by:
        flatCollect in interface RichIterable<K>
        Specified by:
        flatCollect in interface UnsortedMapIterable<K,​V>
        Parameters:
        function - The Function to apply
        Returns:
        a new flattened collection produced by applying the given function
      • select

        public ImmutableBag<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"));
         
        Specified by:
        select in interface ImmutableMap<K,​V>
        Specified by:
        select in interface ImmutableMapIterable<K,​V>
        Specified by:
        select in interface RichIterable<K>
        Specified by:
        select in interface UnsortedMapIterable<K,​V>
      • reject

        public ImmutableBag<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 ImmutableMap<K,​V>
        Specified by:
        reject in interface ImmutableMapIterable<K,​V>
        Specified by:
        reject in interface RichIterable<K>
        Specified by:
        reject in interface UnsortedMapIterable<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
      • partitionWith

        public <P> PartitionImmutableBag<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");
         
        Specified by:
        partitionWith in interface ImmutableMap<K,​V>
        Specified by:
        partitionWith in interface RichIterable<K>
        Specified by:
        partitionWith in interface UnsortedMapIterable<K,​V>
      • zip

        @Deprecated
        public <S> ImmutableBag<Pair<V,​S>> zip​(java.lang.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 ImmutableMap<K,​V>
        Specified by:
        zip in interface ImmutableMapIterable<K,​V>
        Specified by:
        zip in interface RichIterable<K>
        Specified by:
        zip in interface UnsortedMapIterable<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.
      • groupBy

        public <VV> ImmutableBagMultimap<VV,​V> groupBy​(Function<? super V,​? extends VV> 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 ImmutableMap<K,​V>
        Specified by:
        groupBy in interface ImmutableMapIterable<K,​V>
        Specified by:
        groupBy in interface RichIterable<K>
        Specified by:
        groupBy in interface UnsortedMapIterable<K,​V>
      • aggregateBy

        public <K1,​V1,​V2> ImmutableMap<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 ImmutableMap<K,​V>
        Specified by:
        aggregateBy in interface ImmutableMapIterable<K,​V>
        Specified by:
        aggregateBy in interface MapIterable<K,​V>
      • countBy

        public <V1> ImmutableBag<V1> countBy​(Function<? super V,​? extends V1> function)
        Description copied from interface: RichIterable
        This method will count the number of occurrences of each value calculated by applying the function to each element of the collection.
        Specified by:
        countBy in interface ImmutableMapIterable<K,​V>
        Specified by:
        countBy in interface RichIterable<K>
        Since:
        9.0
      • countByWith

        public <V1,​P> ImmutableBag<V1> countByWith​(Function2<? super V,​? super P,​? extends V1> function,
                                                         P parameter)
        Description copied from interface: RichIterable
        This method will count the number of occurrences of each value calculated by applying the function to each element of the collection with the specified parameter as the second argument.
        Specified by:
        countByWith in interface ImmutableMapIterable<K,​V>
        Specified by:
        countByWith in interface RichIterable<K>
        Since:
        9.0
      • forEach

        public void forEach​(java.util.function.BiConsumer<? super K,​? super V> action)
        Specified by:
        forEach in interface java.util.Map<K,​V>
        Specified by:
        forEach in interface MapIterable<K,​V>