Class Maps

java.lang.Object
com.google.common.collect.Maps
@GwtCompatible public final class Maps extends Object
Static utility methods pertaining to Map instances (including instances of SortedMap, BiMap, etc.). Also see this class's counterparts Lists, Sets and Queues.

See the Guava User Guide article on Maps.

Since:
2.0
Author:
Kevin Bourrillion, Mike Bostock, Isaac Shum, Louis Wasserman

  • Method Details

    • immutableEnumMap

      public static Enum, V> ImmutableMapV> immutableEnumMap(Map map)
      Returns an immutable map instance containing the given entries. Internally, the returned map will be backed by an EnumMap.

      The iteration order of the returned map follows the enum's iteration order, not the order in which the elements appear in the given map.

      Parameters:
      map - the map to make an immutable copy of
      Returns:
      an immutable map containing those entries
      Since:
      14.0

    • toImmutableEnumMap

      public static @Nullable Object, K extends Enum, V> CollectorImmutableMapV>> toImmutableEnumMap(Function keyFunction, Function valueFunction)
      Returns a Collector that accumulates elements into an ImmutableMap whose keys and values are the result of applying the provided mapping functions to the input elements. The resulting implementation is specialized for enum key types. The returned map and its views will iterate over keys in their enum definition order, not encounter order.

      If the mapped keys contain duplicates, an IllegalArgumentException is thrown when the collection operation is performed. (This differs from the Collector returned by Collectors.toMap(Function, Function), which throws an IllegalStateException.)

      Since:
      21.0

    • toImmutableEnumMap

      public static @Nullable Object, K extends Enum, V> CollectorImmutableMapV>> toImmutableEnumMap(Function keyFunction, Function valueFunction, BinaryOperator mergeFunction)
      Returns a Collector that accumulates elements into an ImmutableMap whose keys and values are the result of applying the provided mapping functions to the input elements. The resulting implementation is specialized for enum key types. The returned map and its views will iterate over keys in their enum definition order, not encounter order.

      If the mapped keys contain duplicates, the values are merged using the specified merging function.

      Since:
      21.0

    • newHashMap

      public static @Nullable Object, V extends @Nullable Object> HashMapV> newHashMap()
      Creates a mutable, empty HashMap instance.

      Note: if mutability is not required, use ImmutableMap.of() instead.

      Note: if K is an enum type, use newEnumMap(Class) instead.

      Note: this method is now unnecessary and should be treated as deprecated. Instead, use the HashMap constructor directly, taking advantage of "diamond" syntax.

      Returns:
      a new, empty HashMap

    • newHashMap

      public static @Nullable Object, V extends @Nullable Object> HashMapV> newHashMap(Map map)
      Creates a mutable HashMap instance with the same mappings as the specified map.

      Note: if mutability is not required, use ImmutableMap.copyOf(Map) instead.

      Note: if K is an Enum type, use newEnumMap(Class) instead.

      Note: this method is now unnecessary and should be treated as deprecated. Instead, use the HashMap constructor directly, taking advantage of "diamond" syntax.

      Parameters:
      map - the mappings to be placed in the new map
      Returns:
      a new HashMap initialized with the mappings from map

    • newHashMapWithExpectedSize

      public static @Nullable Object, V extends @Nullable Object> HashMapV> newHashMapWithExpectedSize(int expectedSize)
      Creates a HashMap instance, with a high enough "initial capacity" that it should hold expectedSize elements without growth. This behavior cannot be broadly guaranteed, but it is observed to be true for OpenJDK 1.7. It also can't be guaranteed that the method isn't inadvertently oversizing the returned map.
      Parameters:
      expectedSize - the number of entries you expect to add to the returned map
      Returns:
      a new, empty HashMap with enough capacity to hold expectedSize entries without resizing
      Throws:
      IllegalArgumentException - if expectedSize is negative

    • newLinkedHashMap

      public static @Nullable Object, V extends @Nullable Object> LinkedHashMapV> newLinkedHashMap()
      Creates a mutable, empty, insertion-ordered LinkedHashMap instance.

      Note: if mutability is not required, use ImmutableMap.of() instead.

      Note: this method is now unnecessary and should be treated as deprecated. Instead, use the LinkedHashMap constructor directly, taking advantage of "diamond" syntax.

      Returns:
      a new, empty LinkedHashMap

    • newLinkedHashMap

      public static @Nullable Object, V extends @Nullable Object> LinkedHashMapV> newLinkedHashMap(Map map)
      Creates a mutable, insertion-ordered LinkedHashMap instance with the same mappings as the specified map.

      Note: if mutability is not required, use ImmutableMap.copyOf(Map) instead.

      Note: this method is now unnecessary and should be treated as deprecated. Instead, use the LinkedHashMap constructor directly, taking advantage of "diamond" syntax.

      Parameters:
      map - the mappings to be placed in the new map
      Returns:
      a new, LinkedHashMap initialized with the mappings from map

    • newLinkedHashMapWithExpectedSize

      public static @Nullable Object, V extends @Nullable Object> LinkedHashMapV> newLinkedHashMapWithExpectedSize(int expectedSize)
      Creates a LinkedHashMap instance, with a high enough "initial capacity" that it should hold expectedSize elements without growth. This behavior cannot be broadly guaranteed, but it is observed to be true for OpenJDK 1.7. It also can't be guaranteed that the method isn't inadvertently oversizing the returned map.
      Parameters:
      expectedSize - the number of entries you expect to add to the returned map
      Returns:
      a new, empty LinkedHashMap with enough capacity to hold expectedSize entries without resizing
      Throws:
      IllegalArgumentException - if expectedSize is negative
      Since:
      19.0

    • newConcurrentMap

      public static V> ConcurrentMapV> newConcurrentMap()
      Creates a new empty ConcurrentHashMap instance.

      Note: this method is now unnecessary and should be treated as deprecated. Instead, use the ConcurrentHashMap constructor directly, taking advantage of "diamond" syntax.

      Since:
      3.0

    • newTreeMap

      public static Comparable, V extends @Nullable Object> TreeMapV> newTreeMap()
      Creates a mutable, empty TreeMap instance using the natural ordering of its elements.

      Note: if mutability is not required, use ImmutableSortedMap.of() instead.

      Note: this method is now unnecessary and should be treated as deprecated. Instead, use the TreeMap constructor directly, taking advantage of "diamond" syntax.

      Returns:
      a new, empty TreeMap

    • newTreeMap

      public static @Nullable Object, V extends @Nullable Object> TreeMapV> newTreeMap(SortedMap map)
      Creates a mutable TreeMap instance with the same mappings as the specified map and using the same ordering as the specified map.

      Note: if mutability is not required, use ImmutableSortedMap.copyOfSorted(SortedMap) instead.

      Note: this method is now unnecessary and should be treated as deprecated. Instead, use the TreeMap constructor directly, taking advantage of "diamond" syntax.

      Parameters:
      map - the sorted map whose mappings are to be placed in the new map and whose comparator is to be used to sort the new map
      Returns:
      a new TreeMap initialized with the mappings from map and using the comparator of map

    • newTreeMap

      public static @Nullable Object, K extends C, V extends @Nullable Object> TreeMapV> newTreeMap(@Nullable Comparator comparator)
      Creates a mutable, empty TreeMap instance using the given comparator.

      Note: if mutability is not required, use ImmutableSortedMap.orderedBy(comparator).build() instead.

      Note: this method is now unnecessary and should be treated as deprecated. Instead, use the TreeMap constructor directly, taking advantage of "diamond" syntax.

      Parameters:
      comparator - the comparator to sort the keys with
      Returns:
      a new, empty TreeMap

    • newEnumMap

      public static Enum, V extends @Nullable Object> EnumMapV> newEnumMap(Class type)
      Creates an EnumMap instance.
      Parameters:
      type - the key type for this map
      Returns:
      a new, empty EnumMap

    • newEnumMap

      public static Enum, V extends @Nullable Object> EnumMapV> newEnumMap(Map map)
      Creates an EnumMap with the same mappings as the specified map.

      Note: this method is now unnecessary and should be treated as deprecated. Instead, use the EnumMap constructor directly, taking advantage of "diamond" syntax.

      Parameters:
      map - the map from which to initialize this EnumMap
      Returns:
      a new EnumMap initialized with the mappings from map
      Throws:
      IllegalArgumentException - if m is not an EnumMap instance and contains no mappings

    • newIdentityHashMap

      public static @Nullable Object, V extends @Nullable Object> IdentityHashMapV> newIdentityHashMap()
      Creates an IdentityHashMap instance.

      Note: this method is now unnecessary and should be treated as deprecated. Instead, use the IdentityHashMap constructor directly, taking advantage of "diamond" syntax.

      Returns:
      a new, empty IdentityHashMap

    • difference

      public static @Nullable Object, V extends @Nullable Object> MapDifferenceV> difference(Map left, Map right)
      Computes the difference between two maps. This difference is an immutable snapshot of the state of the maps at the time this method is called. It will never change, even if the maps change at a later time.

      Since this method uses HashMap instances internally, the keys of the supplied maps must be well-behaved with respect to Object.equals(Object) and Object.hashCode().

      Note:If you only need to know whether two maps have the same mappings, call left.equals(right) instead of this method.

      Parameters:
      left - the map to treat as the "left" map for purposes of comparison
      right - the map to treat as the "right" map for purposes of comparison
      Returns:
      the difference between the two maps

    • difference

      public static @Nullable Object, V extends @Nullable Object> MapDifferenceV> difference(Map left, Map right, Equivalence@NonNull V> valueEquivalence)
      Computes the difference between two maps. This difference is an immutable snapshot of the state of the maps at the time this method is called. It will never change, even if the maps change at a later time.

      Since this method uses HashMap instances internally, the keys of the supplied maps must be well-behaved with respect to Object.equals(Object) and Object.hashCode().

      Parameters:
      left - the map to treat as the "left" map for purposes of comparison
      right - the map to treat as the "right" map for purposes of comparison
      valueEquivalence - the equivalence relationship to use to compare values
      Returns:
      the difference between the two maps
      Since:
      10.0

    • difference

      public static @Nullable Object, V extends @Nullable Object> SortedMapDifferenceV> difference(SortedMap left, Map right)
      Computes the difference between two sorted maps, using the comparator of the left map, or Ordering.natural() if the left map uses the natural ordering of its elements. This difference is an immutable snapshot of the state of the maps at the time this method is called. It will never change, even if the maps change at a later time.

      Since this method uses TreeMap instances internally, the keys of the right map must all compare as distinct according to the comparator of the left map.

      Note:If you only need to know whether two sorted maps have the same mappings, call left.equals(right) instead of this method.

      Parameters:
      left - the map to treat as the "left" map for purposes of comparison
      right - the map to treat as the "right" map for purposes of comparison
      Returns:
      the difference between the two maps
      Since:
      11.0

    • asMap

      public static @Nullable Object, V extends @Nullable Object> MapV> asMap(Set set, Function function)
      Returns a live Map view whose keys are the contents of set and whose values are computed on demand using function. To get an immutable copy instead, use toMap(Iterable, Function).

      Specifically, for each k in the backing set, the returned map has an entry mapping k to function.apply(k). The keySet, values, and entrySet views of the returned map iterate in the same order as the backing set.

      Modifications to the backing set are read through to the returned map. The returned map supports removal operations if the backing set does. Removal operations write through to the backing set. The returned map does not support put operations.

      Warning: If the function rejects null, caution is required to make sure the set does not contain null, because the view cannot stop null from being added to the set.

      Warning: This method assumes that for any instance k of key type K, k.equals(k2) implies that k2 is also of type K. Using a key type for which this may not hold, such as ArrayList, may risk a ClassCastException when calling methods on the resulting map view.

      Since:
      14.0

    • asMap

      public static @Nullable Object, V extends @Nullable Object> SortedMapV> asMap(SortedSet set, Function function)
      Returns a view of the sorted set as a map, mapping keys from the set according to the specified function.

      Specifically, for each k in the backing set, the returned map has an entry mapping k to function.apply(k). The keySet, values, and entrySet views of the returned map iterate in the same order as the backing set.

      Modifications to the backing set are read through to the returned map. The returned map supports removal operations if the backing set does. Removal operations write through to the backing set. The returned map does not support put operations.

      Warning: If the function rejects null, caution is required to make sure the set does not contain null, because the view cannot stop null from being added to the set.

      Warning: This method assumes that for any instance k of key type K, k.equals(k2) implies that k2 is also of type K. Using a key type for which this may not hold, such as ArrayList, may risk a ClassCastException when calling methods on the resulting map view.

      Since:
      14.0

    • asMap

      @GwtIncompatible public static @Nullable Object, V extends @Nullable Object> NavigableMapV> asMap(NavigableSet set, Function function)
      Returns a view of the navigable set as a map, mapping keys from the set according to the specified function.

      Specifically, for each k in the backing set, the returned map has an entry mapping k to function.apply(k). The keySet, values, and entrySet views of the returned map iterate in the same order as the backing set.

      Modifications to the backing set are read through to the returned map. The returned map supports removal operations if the backing set does. Removal operations write through to the backing set. The returned map does not support put operations.

      Warning: If the function rejects null, caution is required to make sure the set does not contain null, because the view cannot stop null from being added to the set.

      Warning: This method assumes that for any instance k of key type K, k.equals(k2) implies that k2 is also of type K. Using a key type for which this may not hold, such as ArrayList, may risk a ClassCastException when calling methods on the resulting map view.

      Since:
      14.0

    • toMap

      public static V> ImmutableMapV> toMap(Iterable keys, Function valueFunction)
      Returns an immutable map whose keys are the distinct elements of keys and whose value for each key was computed by valueFunction. The map's iteration order is the order of the first appearance of each key in keys.

      When there are multiple instances of a key in keys, it is unspecified whether valueFunction will be applied to more than one instance of that key and, if it is, which result will be mapped to that key in the returned map.

      If keys is a Set, a live view can be obtained instead of a copy using asMap(Set, Function).

      Note: on Java 8+, it is usually better to use streams. For example: 

      import static com.google.common.collect.ImmutableMap.toImmutableMap;
...
ImmutableMap colorNames =
    allColors.stream().collect(toImmutableMap(c -> c, c -> c.toString()));

      Streams provide a more standard and flexible API and the lambdas make it clear what the keys and values in the map are.

      Throws:
      NullPointerException - if any element of keys is null, or if valueFunction produces null for any key
      Since:
      14.0

    • toMap

      public static V> ImmutableMapV> toMap(Iterator keys, Function valueFunction)
      Returns an immutable map whose keys are the distinct elements of keys and whose value for each key was computed by valueFunction. The map's iteration order is the order of the first appearance of each key in keys.

      When there are multiple instances of a key in keys, it is unspecified whether valueFunction will be applied to more than one instance of that key and, if it is, which result will be mapped to that key in the returned map.

      Throws:
      NullPointerException - if any element of keys is null, or if valueFunction produces null for any key
      Since:
      14.0

    • uniqueIndex

      @CanIgnoreReturnValue public static V> ImmutableMapV> uniqueIndex(Iterable values, Function keyFunction)
      Returns a map with the given values, indexed by keys derived from those values. In other words, each input value produces an entry in the map whose key is the result of applying keyFunction to that value. These entries appear in the same order as the input values. Example usage: 
      Color red = new Color("red", 255, 0, 0);
...
ImmutableSet allColors = ImmutableSet.of(red, green, blue);

ImmutableMap colorForName = uniqueIndex(allColors, c -> c.toString());
assertThat(colorForName).containsEntry("red", red);

      If your index may associate multiple values with each key, use Multimaps.index.

      Note: on Java 8+, it is usually better to use streams. For example: 

      import static com.google.common.collect.ImmutableMap.toImmutableMap;
...
ImmutableMap colorForName =
    allColors.stream().collect(toImmutableMap(c -> c.toString(), c -> c));

      Streams provide a more standard and flexible API and the lambdas make it clear what the keys and values in the map are.

      Parameters:
      values - the values to use when constructing the Map
      keyFunction - the function used to produce the key for each value
      Returns:
      a map mapping the result of evaluating the function keyFunction on each value in the input collection to that value
      Throws:
      IllegalArgumentException - if keyFunction produces the same key for more than one value in the input collection
      NullPointerException - if any element of values is null, or if keyFunction produces null for any value

    • uniqueIndex

      @CanIgnoreReturnValue public static V> ImmutableMapV> uniqueIndex(Iterator values, Function keyFunction)
      Returns a map with the given values, indexed by keys derived from those values. In other words, each input value produces an entry in the map whose key is the result of applying keyFunction to that value. These entries appear in the same order as the input values. Example usage: 
      Color red = new Color("red", 255, 0, 0);
...
Iterator allColors = ImmutableSet.of(red, green, blue).iterator();

Map colorForName = uniqueIndex(allColors, toStringFunction());
assertThat(colorForName).containsEntry("red", red);

      If your index may associate multiple values with each key, use Multimaps.index.

      Parameters:
      values - the values to use when constructing the Map
      keyFunction - the function used to produce the key for each value
      Returns:
      a map mapping the result of evaluating the function keyFunction on each value in the input collection to that value
      Throws:
      IllegalArgumentException - if keyFunction produces the same key for more than one value in the input collection
      NullPointerException - if any element of values is null, or if keyFunction produces null for any value
      Since:
      10.0

    • fromProperties

      @GwtIncompatible public static ImmutableMap<String,String> fromProperties(Properties properties)
      Creates an ImmutableMap from a Properties instance. Properties normally derive from Map, but they typically contain strings, which is awkward. This method lets you get a plain-old-Map out of a Properties.
      Parameters:
      properties - a Properties object to be converted
      Returns:
      an immutable map containing all the entries in properties
      Throws:
      ClassCastException - if any key in properties is not a String
      NullPointerException - if any key or value in properties is null

    • immutableEntry

      public static @Nullable Object, V extends @Nullable Object> Map.EntryV> immutableEntry(K key, V value)
      Returns an immutable map entry with the specified key and value. The Map.Entry.setValue(V) operation throws an UnsupportedOperationException.

      The returned entry is serializable.

      Java 9 users: consider using java.util.Map.entry(key, value) if the key and value are non-null and the entry does not need to be serializable.

      Parameters:
      key - the key to be associated with the returned entry
      value - the value to be associated with the returned entry

    • asConverter

      public static B> ConverterB> asConverter(BiMapB> bimap)
      Returns a Converter that converts values using bimap.get(), and whose inverse view converts values using bimap.inverse().get().

      To use a plain Map as a Function, see Functions.forMap(Map) or Functions.forMap(Map, Object).

      Since:
      16.0

    • synchronizedBiMap

      public static @Nullable Object, V extends @Nullable Object> BiMapV> synchronizedBiMap(BiMapV> bimap)
      Returns a synchronized (thread-safe) bimap backed by the specified bimap. In order to guarantee serial access, it is critical that all access to the backing bimap is accomplished through the returned bimap.

      It is imperative that the user manually synchronize on the returned map when accessing any of its collection views: 

      BiMap map = Maps.synchronizedBiMap(HashBiMap.create());
...
Set set = map.keySet(); // Needn't be in synchronized block
...
synchronized (map) { // Synchronizing on map, not set!
  Iterator it = set.iterator(); // Must be in synchronized block
  while (it.hasNext()) {
    foo(it.next());
  }
}

      Failure to follow this advice may result in non-deterministic behavior.

      The returned bimap will be serializable if the specified bimap is serializable.

      Parameters:
      bimap - the bimap to be wrapped in a synchronized view
      Returns:
      a synchronized view of the specified bimap

    • unmodifiableBiMap

      public static @Nullable Object, V extends @Nullable Object> BiMapV> unmodifiableBiMap(BiMap bimap)
      Returns an unmodifiable view of the specified bimap. This method allows modules to provide users with "read-only" access to internal bimaps. Query operations on the returned bimap "read through" to the specified bimap, and attempts to modify the returned map, whether direct or via its collection views, result in an UnsupportedOperationException.

      The returned bimap will be serializable if the specified bimap is serializable.

      Parameters:
      bimap - the bimap for which an unmodifiable view is to be returned
      Returns:
      an unmodifiable view of the specified bimap

    • transformValues

      public static @Nullable Object, V1 extends @Nullable Object, V2 extends @Nullable Object> MapV2> transformValues(MapV1> fromMap, Function function)
      Returns a view of a map where each value is transformed by a function. All other properties of the map, such as iteration order, are left intact. For example, the code: 
      Map map = ImmutableMap.of("a", 4, "b", 9);
Function sqrt = (Integer in) -> Math.sqrt(in);
Map transformed = Maps.transformValues(map, sqrt);
System.out.println(transformed);
      ... prints {a=2.0, b=3.0}.

      Changes in the underlying map are reflected in this view. Conversely, this view supports removal operations, and these are reflected in the underlying map.

      It's acceptable for the underlying map to contain null keys, and even null values provided that the function is capable of accepting null input. The transformed map might contain null values, if the function sometimes gives a null result.

      The returned map is not thread-safe or serializable, even if the underlying map is.

      The function is applied lazily, invoked when needed. This is necessary for the returned map to be a view, but it means that the function will be applied many times for bulk operations like Map.containsValue(Object) and Map.toString(). For this to perform well, function should be fast. To avoid lazy evaluation when the returned map doesn't need to be a view, copy the returned map into a new map of your choosing.

    • transformValues

      public static @Nullable Object, V1 extends @Nullable Object, V2 extends @Nullable Object> SortedMapV2> transformValues(SortedMapV1> fromMap, Function function)
      Returns a view of a sorted map where each value is transformed by a function. All other properties of the map, such as iteration order, are left intact. For example, the code: 
      SortedMap map = ImmutableSortedMap.of("a", 4, "b", 9);
Function sqrt = (Integer in) -> Math.sqrt(in);
SortedMap transformed = Maps.transformValues(map, sqrt);
System.out.println(transformed);
      ... prints {a=2.0, b=3.0}.

      Changes in the underlying map are reflected in this view. Conversely, this view supports removal operations, and these are reflected in the underlying map.

      It's acceptable for the underlying map to contain null keys, and even null values provided that the function is capable of accepting null input. The transformed map might contain null values, if the function sometimes gives a null result.

      The returned map is not thread-safe or serializable, even if the underlying map is.

      The function is applied lazily, invoked when needed. This is necessary for the returned map to be a view, but it means that the function will be applied many times for bulk operations like Map.containsValue(Object) and Map.toString(). For this to perform well, function should be fast. To avoid lazy evaluation when the returned map doesn't need to be a view, copy the returned map into a new map of your choosing.

      Since:
      11.0

    • transformValues

      @GwtIncompatible public static @Nullable Object, V1 extends @Nullable Object, V2 extends @Nullable Object> NavigableMapV2> transformValues(NavigableMapV1> fromMap, Function function)
      Returns a view of a navigable map where each value is transformed by a function. All other properties of the map, such as iteration order, are left intact. For example, the code: 
      NavigableMap map = Maps.newTreeMap();
map.put("a", 4);
map.put("b", 9);
Function sqrt = (Integer in) -> Math.sqrt(in);
NavigableMap transformed = Maps.transformNavigableValues(map, sqrt);
System.out.println(transformed);
      ... prints {a=2.0, b=3.0}.

      Changes in the underlying map are reflected in this view. Conversely, this view supports removal operations, and these are reflected in the underlying map.

      It's acceptable for the underlying map to contain null keys, and even null values provided that the function is capable of accepting null input. The transformed map might contain null values, if the function sometimes gives a null result.

      The returned map is not thread-safe or serializable, even if the underlying map is.

      The function is applied lazily, invoked when needed. This is necessary for the returned map to be a view, but it means that the function will be applied many times for bulk operations like Map.containsValue(Object) and Map.toString(). For this to perform well, function should be fast. To avoid lazy evaluation when the returned map doesn't need to be a view, copy the returned map into a new map of your choosing.

      Since:
      13.0

    • transformEntries

      public static @Nullable Object, V1 extends @Nullable Object, V2 extends @Nullable Object> MapV2> transformEntries(MapV1> fromMap, Maps.EntryTransformer transformer)
      Returns a view of a map whose values are derived from the original map's entries. In contrast to transformValues(Map, Function), this method's entry-transformation logic may depend on the key as well as the value.

      All other properties of the transformed map, such as iteration order, are left intact. For example, the code: 

      Map options = ImmutableMap.of("verbose", true, "sort", false);
EntryTransformer flagPrefixer =
    (key, value) -> value ? key : "no" + key;
Map transformed = Maps.transformEntries(options, flagPrefixer);
System.out.println(transformed);
      ... prints {verbose=verbose, sort=nosort}.

      Changes in the underlying map are reflected in this view. Conversely, this view supports removal operations, and these are reflected in the underlying map.

      It's acceptable for the underlying map to contain null keys and null values provided that the transformer is capable of accepting null inputs. The transformed map might contain null values if the transformer sometimes gives a null result.

      The returned map is not thread-safe or serializable, even if the underlying map is.

      The transformer is applied lazily, invoked when needed. This is necessary for the returned map to be a view, but it means that the transformer will be applied many times for bulk operations like Map.containsValue(Object) and Object.toString(). For this to perform well, transformer should be fast. To avoid lazy evaluation when the returned map doesn't need to be a view, copy the returned map into a new map of your choosing.

      Warning: This method assumes that for any instance k of EntryTransformer key type K, k.equals(k2) implies that k2 is also of type K. Using an EntryTransformer key type for which this may not hold, such as ArrayList, may risk a ClassCastException when calling methods on the transformed map.

      Since:
      7.0

    • transformEntries

      public static @Nullable Object, V1 extends @Nullable Object, V2 extends @Nullable Object> SortedMapV2> transformEntries(SortedMapV1> fromMap, Maps.EntryTransformer transformer)
      Returns a view of a sorted map whose values are derived from the original sorted map's entries. In contrast to transformValues(Map, Function), this method's entry-transformation logic may depend on the key as well as the value.

      All other properties of the transformed map, such as iteration order, are left intact. For example, the code: 

      Map options = ImmutableSortedMap.of("verbose", true, "sort", false);
EntryTransformer flagPrefixer =
    (key, value) -> value ? key : "no" + key;
SortedMap transformed = Maps.transformEntries(options, flagPrefixer);
System.out.println(transformed);
      ... prints {sort=nosort, verbose=verbose}.

      Changes in the underlying map are reflected in this view. Conversely, this view supports removal operations, and these are reflected in the underlying map.

      It's acceptable for the underlying map to contain null keys and null values provided that the transformer is capable of accepting null inputs. The transformed map might contain null values if the transformer sometimes gives a null result.

      The returned map is not thread-safe or serializable, even if the underlying map is.

      The transformer is applied lazily, invoked when needed. This is necessary for the returned map to be a view, but it means that the transformer will be applied many times for bulk operations like Map.containsValue(Object) and Object.toString(). For this to perform well, transformer should be fast. To avoid lazy evaluation when the returned map doesn't need to be a view, copy the returned map into a new map of your choosing.

      Warning: This method assumes that for any instance k of EntryTransformer key type K, k.equals(k2) implies that k2 is also of type K. Using an EntryTransformer key type for which this may not hold, such as ArrayList, may risk a ClassCastException when calling methods on the transformed map.

      Since:
      11.0

    • transformEntries

      @GwtIncompatible public static @Nullable Object, V1 extends @Nullable Object, V2 extends @Nullable Object> NavigableMapV2> transformEntries(NavigableMapV1> fromMap, Maps.EntryTransformer transformer)
      Returns a view of a navigable map whose values are derived from the original navigable map's entries. In contrast to transformValues(Map, Function), this method's entry-transformation logic may depend on the key as well as the value.

      All other properties of the transformed map, such as iteration order, are left intact. For example, the code: 

      NavigableMap options = Maps.newTreeMap();
options.put("verbose", false);
options.put("sort", true);
EntryTransformer flagPrefixer =
    (key, value) -> value ? key : "no" + key;
NavigableMap transformed = Maps.transformEntries(options, flagPrefixer);
System.out.println(transformed);
      ... prints {sort=nosort, verbose=verbose}.

      Changes in the underlying map are reflected in this view. Conversely, this view supports removal operations, and these are reflected in the underlying map.

      It's acceptable for the underlying map to contain null keys and null values provided that the transformer is capable of accepting null inputs. The transformed map might contain null values if the transformer sometimes gives a null result.

      The returned map is not thread-safe or serializable, even if the underlying map is.

      The transformer is applied lazily, invoked when needed. This is necessary for the returned map to be a view, but it means that the transformer will be applied many times for bulk operations like Map.containsValue(Object) and Object.toString(). For this to perform well, transformer should be fast. To avoid lazy evaluation when the returned map doesn't need to be a view, copy the returned map into a new map of your choosing.

      Warning: This method assumes that for any instance k of EntryTransformer key type K, k.equals(k2) implies that k2 is also of type K. Using an EntryTransformer key type for which this may not hold, such as ArrayList, may risk a ClassCastException when calling methods on the transformed map.

      Since:
      13.0

    • filterKeys

      public static @Nullable Object, V extends @Nullable Object> MapV> filterKeys(MapV> unfiltered, Predicate keyPredicate)
      Returns a map containing the mappings in unfiltered whose keys satisfy a predicate. The returned map is a live view of unfiltered; changes to one affect the other.

      The resulting map's keySet(), entrySet(), and values() views have iterators that don't support remove(), but all other methods are supported by the map and its views. When given a key that doesn't satisfy the predicate, the map's put() and putAll() methods throw an IllegalArgumentException.

      When methods such as removeAll() and clear() are called on the filtered map or its views, only mappings whose keys satisfy the filter will be removed from the underlying map.

      The returned map isn't threadsafe or serializable, even if unfiltered is.

      Many of the filtered map's methods, such as size(), iterate across every key/value mapping in the underlying map and determine which satisfy the filter. When a live view is not needed, it may be faster to copy the filtered map and use the copy.

      Warning: keyPredicate must be consistent with equals, as documented at Predicate.apply(T). Do not provide a predicate such as Predicates.instanceOf(ArrayList.class), which is inconsistent with equals.

    • filterKeys

      public static @Nullable Object, V extends @Nullable Object> SortedMapV> filterKeys(SortedMapV> unfiltered, Predicate keyPredicate)
      Returns a sorted map containing the mappings in unfiltered whose keys satisfy a predicate. The returned map is a live view of unfiltered; changes to one affect the other.

      The resulting map's keySet(), entrySet(), and values() views have iterators that don't support remove(), but all other methods are supported by the map and its views. When given a key that doesn't satisfy the predicate, the map's put() and putAll() methods throw an IllegalArgumentException.

      When methods such as removeAll() and clear() are called on the filtered map or its views, only mappings whose keys satisfy the filter will be removed from the underlying map.

      The returned map isn't threadsafe or serializable, even if unfiltered is.

      Many of the filtered map's methods, such as size(), iterate across every key/value mapping in the underlying map and determine which satisfy the filter. When a live view is not needed, it may be faster to copy the filtered map and use the copy.

      Warning: keyPredicate must be consistent with equals, as documented at Predicate.apply(T). Do not provide a predicate such as Predicates.instanceOf(ArrayList.class), which is inconsistent with equals.

      Since:
      11.0

    • filterKeys

      @GwtIncompatible public static @Nullable Object, V extends @Nullable Object> NavigableMapV> filterKeys(NavigableMapV> unfiltered, Predicate keyPredicate)
      Returns a navigable map containing the mappings in unfiltered whose keys satisfy a predicate. The returned map is a live view of unfiltered; changes to one affect the other.

      The resulting map's keySet(), entrySet(), and values() views have iterators that don't support remove(), but all other methods are supported by the map and its views. When given a key that doesn't satisfy the predicate, the map's put() and putAll() methods throw an IllegalArgumentException.

      When methods such as removeAll() and clear() are called on the filtered map or its views, only mappings whose keys satisfy the filter will be removed from the underlying map.

      The returned map isn't threadsafe or serializable, even if unfiltered is.

      Many of the filtered map's methods, such as size(), iterate across every key/value mapping in the underlying map and determine which satisfy the filter. When a live view is not needed, it may be faster to copy the filtered map and use the copy.

      Warning: keyPredicate must be consistent with equals, as documented at Predicate.apply(T). Do not provide a predicate such as Predicates.instanceOf(ArrayList.class), which is inconsistent with equals.

      Since:
      14.0

    • filterKeys

      public static @Nullable Object, V extends @Nullable Object> BiMapV> filterKeys(BiMapV> unfiltered, Predicate keyPredicate)
      Returns a bimap containing the mappings in unfiltered whose keys satisfy a predicate. The returned bimap is a live view of unfiltered; changes to one affect the other.

      The resulting bimap's keySet(), entrySet(), and values() views have iterators that don't support remove(), but all other methods are supported by the bimap and its views. When given a key that doesn't satisfy the predicate, the bimap's put(), forcePut() and putAll() methods throw an IllegalArgumentException.

      When methods such as removeAll() and clear() are called on the filtered bimap or its views, only mappings that satisfy the filter will be removed from the underlying bimap.

      The returned bimap isn't threadsafe or serializable, even if unfiltered is.

      Many of the filtered bimap's methods, such as size(), iterate across every key in the underlying bimap and determine which satisfy the filter. When a live view is not needed, it may be faster to copy the filtered bimap and use the copy.

      Warning: entryPredicate must be consistent with equals , as documented at Predicate.apply(T).

      Since:
      14.0

    • filterValues

      public static @Nullable Object, V extends @Nullable Object> MapV> filterValues(MapV> unfiltered, Predicate valuePredicate)
      Returns a map containing the mappings in unfiltered whose values satisfy a predicate. The returned map is a live view of unfiltered; changes to one affect the other.

      The resulting map's keySet(), entrySet(), and values() views have iterators that don't support remove(), but all other methods are supported by the map and its views. When given a value that doesn't satisfy the predicate, the map's put(), putAll(), and Map.Entry.setValue(V) methods throw an IllegalArgumentException.

      When methods such as removeAll() and clear() are called on the filtered map or its views, only mappings whose values satisfy the filter will be removed from the underlying map.

      The returned map isn't threadsafe or serializable, even if unfiltered is.

      Many of the filtered map's methods, such as size(), iterate across every key/value mapping in the underlying map and determine which satisfy the filter. When a live view is not needed, it may be faster to copy the filtered map and use the copy.

      Warning: valuePredicate must be consistent with equals, as documented at Predicate.apply(T). Do not provide a predicate such as Predicates.instanceOf(ArrayList.class), which is inconsistent with equals.

    • filterValues

      public static @Nullable Object, V extends @Nullable Object> SortedMapV> filterValues(SortedMapV> unfiltered, Predicate valuePredicate)
      Returns a sorted map containing the mappings in unfiltered whose values satisfy a predicate. The returned map is a live view of unfiltered; changes to one affect the other.

      The resulting map's keySet(), entrySet(), and values() views have iterators that don't support remove(), but all other methods are supported by the map and its views. When given a value that doesn't satisfy the predicate, the map's put(), putAll(), and Map.Entry.setValue(V) methods throw an IllegalArgumentException.

      When methods such as removeAll() and clear() are called on the filtered map or its views, only mappings whose values satisfy the filter will be removed from the underlying map.

      The returned map isn't threadsafe or serializable, even if unfiltered is.

      Many of the filtered map's methods, such as size(), iterate across every key/value mapping in the underlying map and determine which satisfy the filter. When a live view is not needed, it may be faster to copy the filtered map and use the copy.

      Warning: valuePredicate must be consistent with equals, as documented at Predicate.apply(T). Do not provide a predicate such as Predicates.instanceOf(ArrayList.class), which is inconsistent with equals.

      Since:
      11.0

    • filterValues

      @GwtIncompatible public static @Nullable Object, V extends @Nullable Object> NavigableMapV> filterValues(NavigableMapV> unfiltered, Predicate valuePredicate)
      Returns a navigable map containing the mappings in unfiltered whose values satisfy a predicate. The returned map is a live view of unfiltered; changes to one affect the other.

      The resulting map's keySet(), entrySet(), and values() views have iterators that don't support remove(), but all other methods are supported by the map and its views. When given a value that doesn't satisfy the predicate, the map's put(), putAll(), and Map.Entry.setValue(V) methods throw an IllegalArgumentException.

      When methods such as removeAll() and clear() are called on the filtered map or its views, only mappings whose values satisfy the filter will be removed from the underlying map.

      The returned map isn't threadsafe or serializable, even if unfiltered is.

      Many of the filtered map's methods, such as size(), iterate across every key/value mapping in the underlying map and determine which satisfy the filter. When a live view is not needed, it may be faster to copy the filtered map and use the copy.

      Warning: valuePredicate must be consistent with equals, as documented at Predicate.apply(T). Do not provide a predicate such as Predicates.instanceOf(ArrayList.class), which is inconsistent with equals.

      Since:
      14.0

    • filterValues

      public static @Nullable Object, V extends @Nullable Object> BiMapV> filterValues(BiMapV> unfiltered, Predicate valuePredicate)
      Returns a bimap containing the mappings in unfiltered whose values satisfy a predicate. The returned bimap is a live view of unfiltered; changes to one affect the other.

      The resulting bimap's keySet(), entrySet(), and values() views have iterators that don't support remove(), but all other methods are supported by the bimap and its views. When given a value that doesn't satisfy the predicate, the bimap's put(), forcePut() and putAll() methods throw an IllegalArgumentException. Similarly, the map's entries have a Map.Entry.setValue(V) method that throws an IllegalArgumentException when the provided value doesn't satisfy the predicate.

      When methods such as removeAll() and clear() are called on the filtered bimap or its views, only mappings that satisfy the filter will be removed from the underlying bimap.

      The returned bimap isn't threadsafe or serializable, even if unfiltered is.

      Many of the filtered bimap's methods, such as size(), iterate across every value in the underlying bimap and determine which satisfy the filter. When a live view is not needed, it may be faster to copy the filtered bimap and use the copy.

      Warning: entryPredicate must be consistent with equals , as documented at Predicate.apply(T).

      Since:
      14.0

    • filterEntries

      public static @Nullable Object, V extends @Nullable Object> MapV> filterEntries(MapV> unfiltered, PredicateMap.EntryV>> entryPredicate)
      Returns a map containing the mappings in unfiltered that satisfy a predicate. The returned map is a live view of unfiltered; changes to one affect the other.

      The resulting map's keySet(), entrySet(), and values() views have iterators that don't support remove(), but all other methods are supported by the map and its views. When given a key/value pair that doesn't satisfy the predicate, the map's put() and putAll() methods throw an IllegalArgumentException. Similarly, the map's entries have a Map.Entry.setValue(V) method that throws an IllegalArgumentException when the existing key and the provided value don't satisfy the predicate.

      When methods such as removeAll() and clear() are called on the filtered map or its views, only mappings that satisfy the filter will be removed from the underlying map.

      The returned map isn't threadsafe or serializable, even if unfiltered is.

      Many of the filtered map's methods, such as size(), iterate across every key/value mapping in the underlying map and determine which satisfy the filter. When a live view is not needed, it may be faster to copy the filtered map and use the copy.

      Warning: entryPredicate must be consistent with equals, as documented at Predicate.apply(T).

    • filterEntries

      public static @Nullable Object, V extends @Nullable Object> SortedMapV> filterEntries(SortedMapV> unfiltered, PredicateMap.EntryV>> entryPredicate)
      Returns a sorted map containing the mappings in unfiltered that satisfy a predicate. The returned map is a live view of unfiltered; changes to one affect the other.

      The resulting map's keySet(), entrySet(), and values() views have iterators that don't support remove(), but all other methods are supported by the map and its views. When given a key/value pair that doesn't satisfy the predicate, the map's put() and putAll() methods throw an IllegalArgumentException. Similarly, the map's entries have a Map.Entry.setValue(V) method that throws an IllegalArgumentException when the existing key and the provided value don't satisfy the predicate.

      When methods such as removeAll() and clear() are called on the filtered map or its views, only mappings that satisfy the filter will be removed from the underlying map.

      The returned map isn't threadsafe or serializable, even if unfiltered is.

      Many of the filtered map's methods, such as size(), iterate across every key/value mapping in the underlying map and determine which satisfy the filter. When a live view is not needed, it may be faster to copy the filtered map and use the copy.

      Warning: entryPredicate must be consistent with equals, as documented at Predicate.apply(T).

      Since:
      11.0

    • filterEntries

      @GwtIncompatible public static @Nullable Object, V extends @Nullable Object> NavigableMapV> filterEntries(NavigableMapV> unfiltered, PredicateMap.EntryV>> entryPredicate)
      Returns a sorted map containing the mappings in unfiltered that satisfy a predicate. The returned map is a live view of unfiltered; changes to one affect the other.

      The resulting map's keySet(), entrySet(), and values() views have iterators that don't support remove(), but all other methods are supported by the map and its views. When given a key/value pair that doesn't satisfy the predicate, the map's put() and putAll() methods throw an IllegalArgumentException. Similarly, the map's entries have a Map.Entry.setValue(V) method that throws an IllegalArgumentException when the existing key and the provided value don't satisfy the predicate.

      When methods such as removeAll() and clear() are called on the filtered map or its views, only mappings that satisfy the filter will be removed from the underlying map.

      The returned map isn't threadsafe or serializable, even if unfiltered is.

      Many of the filtered map's methods, such as size(), iterate across every key/value mapping in the underlying map and determine which satisfy the filter. When a live view is not needed, it may be faster to copy the filtered map and use the copy.

      Warning: entryPredicate must be consistent with equals, as documented at Predicate.apply(T).

      Since:
      14.0

    • filterEntries

      public static @Nullable Object, V extends @Nullable Object> BiMapV> filterEntries(BiMapV> unfiltered, PredicateMap.EntryV>> entryPredicate)
      Returns a bimap containing the mappings in unfiltered that satisfy a predicate. The returned bimap is a live view of unfiltered; changes to one affect the other.

      The resulting bimap's keySet(), entrySet(), and values() views have iterators that don't support remove(), but all other methods are supported by the bimap and its views. When given a key/value pair that doesn't satisfy the predicate, the bimap's put(), forcePut() and putAll() methods throw an IllegalArgumentException. Similarly, the map's entries have an Map.Entry.setValue(V) method that throws an IllegalArgumentException when the existing key and the provided value don't satisfy the predicate.

      When methods such as removeAll() and clear() are called on the filtered bimap or its views, only mappings that satisfy the filter will be removed from the underlying bimap.

      The returned bimap isn't threadsafe or serializable, even if unfiltered is.

      Many of the filtered bimap's methods, such as size(), iterate across every key/value mapping in the underlying bimap and determine which satisfy the filter. When a live view is not needed, it may be faster to copy the filtered bimap and use the copy.

      Warning: entryPredicate must be consistent with equals , as documented at Predicate.apply(T).

      Since:
      14.0

    • unmodifiableNavigableMap

      @GwtIncompatible public static @Nullable Object, V extends @Nullable Object> NavigableMapV> unmodifiableNavigableMap(NavigableMap map)
      Returns an unmodifiable view of the specified navigable map. Query operations on the returned map read through to the specified map, and attempts to modify the returned map, whether direct or via its views, result in an UnsupportedOperationException.

      The returned navigable map will be serializable if the specified navigable map is serializable.

      This method's signature will not permit you to convert a NavigableMap to a NavigableMap. If it permitted this, the returned map's comparator() method might return a Comparator, which works only on a particular subtype of K, but promise that it's a Comparator, which must work on any type of K.

      Parameters:
      map - the navigable map for which an unmodifiable view is to be returned
      Returns:
      an unmodifiable view of the specified navigable map
      Since:
      12.0

    • synchronizedNavigableMap

      @GwtIncompatible public static @Nullable Object, V extends @Nullable Object> NavigableMapV> synchronizedNavigableMap(NavigableMapV> navigableMap)
      Returns a synchronized (thread-safe) navigable map backed by the specified navigable map. In order to guarantee serial access, it is critical that all access to the backing navigable map is accomplished through the returned navigable map (or its views).

      It is imperative that the user manually synchronize on the returned navigable map when iterating over any of its collection views, or the collections views of any of its descendingMap, subMap, headMap or tailMap views. 

      NavigableMap map = synchronizedNavigableMap(new TreeMap());

// Needn't be in synchronized block
NavigableSet set = map.navigableKeySet();

synchronized (map) { // Synchronizing on map, not set!
  Iterator it = set.iterator(); // Must be in synchronized block
  while (it.hasNext()) {
    foo(it.next());
  }
}

      or: 

      NavigableMap map = synchronizedNavigableMap(new TreeMap());
NavigableMap map2 = map.subMap(foo, false, bar, true);

// Needn't be in synchronized block
NavigableSet set2 = map2.descendingKeySet();

synchronized (map) { // Synchronizing on map, not map2 or set2!
  Iterator it = set2.iterator(); // Must be in synchronized block
  while (it.hasNext()) {
    foo(it.next());
  }
}

      Failure to follow this advice may result in non-deterministic behavior.

      The returned navigable map will be serializable if the specified navigable map is serializable.

      Parameters:
      navigableMap - the navigable map to be "wrapped" in a synchronized navigable map.
      Returns:
      a synchronized view of the specified navigable map.
      Since:
      13.0

    • subMap

      @GwtIncompatible public static Comparable, V extends @Nullable Object> NavigableMapV> subMap(NavigableMapV> map, Range range)
      Returns a view of the portion of map whose keys are contained by range.

      This method delegates to the appropriate methods of NavigableMap (namely subMap(), tailMap(), and headMap()) to actually construct the view. Consult these methods for a full description of the returned view's behavior.

      Warning: Ranges always represent a range of values using the values' natural ordering. NavigableMap on the other hand can specify a custom ordering via a Comparator, which can violate the natural ordering. Using this method (or in general using Range) with unnaturally-ordered maps can lead to unexpected and undefined behavior.

      Since:
      20.0