Package org.elasticsearch.common.util

Class Maps

java.lang.Object
org.elasticsearch.common.util.Maps
public class Maps extends Object

  • Constructor Details

    • Maps

      public Maps()

  • Method Details

    • deepEquals

      public static <K, V> boolean deepEquals(Map<K,V> left, Map<K,V> right)
      Returns true if the two specified maps are equal to one another. Two maps are considered equal if both represent identical mappings where values are checked with Objects.deepEquals. The primary use case is to check if two maps with array values are equal.
      Parameters:
      left - one map to be tested for equality
      right - the other map to be tested for equality
      Returns:
      true if the two maps are equal

    • copyMapWithRemovedEntry

      public static <K, V> Map<K,V> copyMapWithRemovedEntry(Map<K,V> map, K key)
      Remove the specified key from the provided immutable map by copying the underlying map and filtering out the specified key if that key exists.
      Type Parameters:
      K - the type of the keys in the map
      V - the type of the values in the map
      Parameters:
      map - the immutable map to remove the key from
      key - the key to be removed
      Returns:
      an immutable map that contains the items from the specified map with the provided key removed

    • flatten

      public static Map<String,Object> flatten(Map<String,Object> map, boolean flattenArrays, boolean ordered)
      Returns an array where all internal maps and optionally arrays are flattened into the root map. For example the map {"foo": {"bar": 1, "baz": [2, 3]}} will become {"foo.bar": 1, "foo.baz.0": 2, "foo.baz.1": 3}. Note that if maps contains keys with "." or numbers it is possible that such keys will be silently overridden. For example the map {"foo": {"bar": 1}, "foo.bar": 2} will become {"foo.bar": 1} or {"foo.bar": 2}.
      Parameters:
      map - - input to be flattened
      flattenArrays - - if false, arrays will be ignored
      ordered - - if true the resulted map will be sorted
      Returns:

    • toUnmodifiableSortedMap

      public static <T, K, V> Collector<T,?,NavigableMap<K,V>> toUnmodifiableSortedMap(Function<T,? extends K> keyMapper, Function<T,? extends V> valueMapper)
      Returns a Collector that accumulates the input elements into a sorted map and finishes the resulting set into an unmodifiable sorted map. The resulting read-only view through the unmodifiable sorted map is a sorted map.
      Type Parameters:
      T - the type of the input elements
      Returns:
      an unmodifiable NavigableMap where the underlying map is sorted

    • toUnmodifiableOrderedMap

      public static <T, K, V> Collector<T,?,Map<K,V>> toUnmodifiableOrderedMap(Function<T,? extends K> keyMapper, Function<T,? extends V> valueMapper)
      Returns a Collector that accumulates the input elements into a linked hash map and finishes the resulting set into an unmodifiable map. The resulting read-only view through the unmodifiable map is a linked hash map.
      Type Parameters:
      T - the type of the input elements
      Returns:
      an unmodifiable Map where the underlying map has a consistent order