Class ImmutableMap<K,V>

    • Method Detail

      • of

        public static <K,V> ImmutableMap<K,V> of()
        Returns the empty map. This map behaves and performs comparably to Collections.emptyMap(), and is preferable mainly for consistency and maintainability of your code.
      • of

        public static <K,V> ImmutableMap<K,V> of(K k1,
                                                 V v1)
        Returns an immutable map containing a single entry. This map behaves and performs comparably to Collections.singletonMap(K, V) but will not accept a null key or value. It is preferable mainly for consistency and maintainability of your code.
      • of

        public static <K,V> ImmutableMap<K,V> of(K k1,
                                                 V v1,
                                                 K k2,
                                                 V v2)
        Returns an immutable map containing the given entries, in order.
        Throws:
        IllegalArgumentException - if duplicate keys are provided
      • of

        public static <K,V> ImmutableMap<K,V> of(K k1,
                                                 V v1,
                                                 K k2,
                                                 V v2,
                                                 K k3,
                                                 V v3)
        Returns an immutable map containing the given entries, in order.
        Throws:
        IllegalArgumentException - if duplicate keys are provided
      • of

        public static <K,V> ImmutableMap<K,V> of(K k1,
                                                 V v1,
                                                 K k2,
                                                 V v2,
                                                 K k3,
                                                 V v3,
                                                 K k4,
                                                 V v4)
        Returns an immutable map containing the given entries, in order.
        Throws:
        IllegalArgumentException - if duplicate keys are provided
      • of

        public static <K,V> ImmutableMap<K,V> of(K k1,
                                                 V v1,
                                                 K k2,
                                                 V v2,
                                                 K k3,
                                                 V v3,
                                                 K k4,
                                                 V v4,
                                                 K k5,
                                                 V v5)
        Returns an immutable map containing the given entries, in order.
        Throws:
        IllegalArgumentException - if duplicate keys are provided
      • copyOf

        public static <K,V> ImmutableMap<K,V> copyOf(Map<? extends K,? extends V> map)
        Returns an immutable map containing the same entries as map. If map somehow contains entries with duplicate keys (for example, if it is a SortedMap whose comparator is not consistent with equals), the results of this method are undefined.

        Despite the method name, this method attempts to avoid actually copying the data when it is safe to do so. The exact circumstances under which a copy will or will not be performed are undocumented and subject to change.

        Throws:
        NullPointerException - if any key or value in map is null
      • copyOf

        @Beta
        public static <K,V> ImmutableMap<K,V> copyOf(Iterable<? extends Map.Entry<? extends K,? extends V>> entries)
        Returns an immutable map containing the specified entries. The returned map iterates over entries in the same order as the original iterable.
        Throws:
        NullPointerException - if any key, value, or entry is null
        IllegalArgumentException - if two entries have the same key
        Since:
        19.0
      • isEmpty

        public boolean isEmpty()
      • containsKey

        public boolean containsKey(Object key)
      • containsValue

        public boolean containsValue(Object value)
      • get

        public abstract V get(Object key)
      • entrySet

        public ImmutableSet<Map.Entry<K,V>> entrySet()
        Returns an immutable set of the mappings in this map. The entries are in the same order as the parameters used to build this map.
      • keySet

        public ImmutableSet<K> keySet()
        Returns an immutable set of the keys in this map. These keys are in the same order as the parameters used to build this map.
      • values

        public ImmutableCollection<V> values()
        Returns an immutable collection of the values in this map. The values are in the same order as the parameters used to build this map.
      • equals

        public boolean equals(Object object)
      • hashCode

        public int hashCode()
      • toString

        public String toString()