Class ImmutableBiMap<K,​V>

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ImmutableBiMap.Builder<K,​V>
      A builder for creating immutable bimap instances, especially public static final bimaps ("constant bimaps").
      • Nested classes/interfaces inherited from interface java.util.Map

        java.util.Map.Entry<K extends java.lang.Object,​V extends java.lang.Object>
    • Method Summary

      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      static <K,​V>
      ImmutableBiMap.Builder<K,​V>
      builder()
      Returns a new builder.
      static <K,​V>
      ImmutableBiMap.Builder<K,​V>
      builderWithExpectedSize​(int expectedSize)
      Returns a new builder, expecting the specified number of entries to be added.
      static <K,​V>
      ImmutableBiMap<K,​V>
      copyOf​(java.lang.Iterable<? extends java.util.Map.Entry<? extends K,​? extends V>> entries)
      Returns an immutable bimap containing the given entries.
      static <K,​V>
      ImmutableBiMap<K,​V>
      copyOf​(java.util.Map<? extends K,​? extends V> map)
      Returns an immutable bimap containing the same entries as map.
      V forcePut​(K key, V value)
      Deprecated.
      Unsupported operation.
      abstract ImmutableBiMap<V,​K> inverse()
      Returns the inverse view of this bimap, which maps each of this bimap's values to its associated key.
      static <K,​V>
      ImmutableBiMap<K,​V>
      of()
      Returns the empty bimap.
      static <K,​V>
      ImmutableBiMap<K,​V>
      of​(K k1, V v1)
      Returns an immutable bimap containing a single entry.
      static <K,​V>
      ImmutableBiMap<K,​V>
      of​(K k1, V v1, K k2, V v2)
      Returns an immutable map containing the given entries, in order.
      static <K,​V>
      ImmutableBiMap<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.
      static <K,​V>
      ImmutableBiMap<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.
      static <K,​V>
      ImmutableBiMap<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.
      static <K,​V>
      ImmutableBiMap<K,​V>
      of​(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5, K k6, V v6)
      Returns an immutable map containing the given entries, in order.
      static <K,​V>
      ImmutableBiMap<K,​V>
      of​(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5, K k6, V v6, K k7, V v7)
      Returns an immutable map containing the given entries, in order.
      static <K,​V>
      ImmutableBiMap<K,​V>
      of​(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5, K k6, V v6, K k7, V v7, K k8, V v8)
      Returns an immutable map containing the given entries, in order.
      static <K,​V>
      ImmutableBiMap<K,​V>
      of​(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5, K k6, V v6, K k7, V v7, K k8, V v8, K k9, V v9)
      Returns an immutable map containing the given entries, in order.
      static <K,​V>
      ImmutableBiMap<K,​V>
      of​(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5, K k6, V v6, K k7, V v7, K k8, V v8, K k9, V v9, K k10, V v10)
      Returns an immutable map containing the given entries, in order.
      static <K,​V>
      ImmutableBiMap<K,​V>
      ofEntries​(java.util.Map.Entry<? extends K,​? extends V>... entries)
      Returns an immutable map containing the given entries, in order.
      ImmutableSet<V> values()
      Returns an immutable set of the values in this map, in the same order they appear in ImmutableMap.entrySet.
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
      • Methods inherited from interface com.google.common.collect.BiMap

        put, putAll
      • Methods inherited from interface java.util.Map

        clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, putIfAbsent, remove, remove, replace, replace, replaceAll, size
    • Method Detail

      • of

        public static <K,​V> ImmutableBiMap<K,​V> of()
        Returns the empty bimap.

        Performance note: the instance returned is a singleton.

      • of

        public static <K,​V> ImmutableBiMap<K,​V> of​(K k1,
                                                               V v1)
        Returns an immutable bimap containing a single entry.
      • of

        public static <K,​V> ImmutableBiMap<K,​V> of​(K k1,
                                                               V v1,
                                                               K k2,
                                                               V v2)
        Returns an immutable map containing the given entries, in order.
        Throws:
        java.lang.IllegalArgumentException - if duplicate keys or values are added
      • of

        public static <K,​V> ImmutableBiMap<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:
        java.lang.IllegalArgumentException - if duplicate keys or values are added
      • of

        public static <K,​V> ImmutableBiMap<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:
        java.lang.IllegalArgumentException - if duplicate keys or values are added
      • of

        public static <K,​V> ImmutableBiMap<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:
        java.lang.IllegalArgumentException - if duplicate keys or values are added
      • of

        public static <K,​V> ImmutableBiMap<K,​V> of​(K k1,
                                                               V v1,
                                                               K k2,
                                                               V v2,
                                                               K k3,
                                                               V v3,
                                                               K k4,
                                                               V v4,
                                                               K k5,
                                                               V v5,
                                                               K k6,
                                                               V v6)
        Returns an immutable map containing the given entries, in order.
        Throws:
        java.lang.IllegalArgumentException - if duplicate keys or values are added
        Since:
        31.0
      • of

        public static <K,​V> ImmutableBiMap<K,​V> of​(K k1,
                                                               V v1,
                                                               K k2,
                                                               V v2,
                                                               K k3,
                                                               V v3,
                                                               K k4,
                                                               V v4,
                                                               K k5,
                                                               V v5,
                                                               K k6,
                                                               V v6,
                                                               K k7,
                                                               V v7)
        Returns an immutable map containing the given entries, in order.
        Throws:
        java.lang.IllegalArgumentException - if duplicate keys or values are added
        Since:
        31.0
      • of

        public static <K,​V> ImmutableBiMap<K,​V> of​(K k1,
                                                               V v1,
                                                               K k2,
                                                               V v2,
                                                               K k3,
                                                               V v3,
                                                               K k4,
                                                               V v4,
                                                               K k5,
                                                               V v5,
                                                               K k6,
                                                               V v6,
                                                               K k7,
                                                               V v7,
                                                               K k8,
                                                               V v8)
        Returns an immutable map containing the given entries, in order.
        Throws:
        java.lang.IllegalArgumentException - if duplicate keys or values are added
        Since:
        31.0
      • of

        public static <K,​V> ImmutableBiMap<K,​V> of​(K k1,
                                                               V v1,
                                                               K k2,
                                                               V v2,
                                                               K k3,
                                                               V v3,
                                                               K k4,
                                                               V v4,
                                                               K k5,
                                                               V v5,
                                                               K k6,
                                                               V v6,
                                                               K k7,
                                                               V v7,
                                                               K k8,
                                                               V v8,
                                                               K k9,
                                                               V v9)
        Returns an immutable map containing the given entries, in order.
        Throws:
        java.lang.IllegalArgumentException - if duplicate keys or values are added
        Since:
        31.0
      • of

        public static <K,​V> ImmutableBiMap<K,​V> of​(K k1,
                                                               V v1,
                                                               K k2,
                                                               V v2,
                                                               K k3,
                                                               V v3,
                                                               K k4,
                                                               V v4,
                                                               K k5,
                                                               V v5,
                                                               K k6,
                                                               V v6,
                                                               K k7,
                                                               V v7,
                                                               K k8,
                                                               V v8,
                                                               K k9,
                                                               V v9,
                                                               K k10,
                                                               V v10)
        Returns an immutable map containing the given entries, in order.
        Throws:
        java.lang.IllegalArgumentException - if duplicate keys or values are added
        Since:
        31.0
      • ofEntries

        @SafeVarargs
        public static <K,​V> ImmutableBiMap<K,​V> ofEntries​(java.util.Map.Entry<? extends K,​? extends V>... entries)
        Returns an immutable map containing the given entries, in order.
        Throws:
        java.lang.IllegalArgumentException - if duplicate keys or values are provided
        Since:
        31.0
      • builderWithExpectedSize

        @Beta
        public static <K,​V> ImmutableBiMap.Builder<K,​V> builderWithExpectedSize​(int expectedSize)
        Returns a new builder, expecting the specified number of entries to be added.

        If expectedSize is exactly the number of entries added to the builder before ImmutableBiMap.Builder.build() is called, the builder is likely to perform better than an unsized builder() would have.

        It is not specified if any performance benefits apply if expectedSize is close to, but not exactly, the number of entries added to the builder.

        Since:
        23.1
      • copyOf

        public static <K,​V> ImmutableBiMap<K,​V> copyOf​(java.util.Map<? extends K,​? extends V> map)
        Returns an immutable bimap 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.

        The returned BiMap iterates over entries in the same order as the entrySet of the original map.

        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:
        java.lang.IllegalArgumentException - if two keys have the same value or two values have the same key
        java.lang.NullPointerException - if any key or value in map is null
      • copyOf

        @Beta
        public static <K,​V> ImmutableBiMap<K,​V> copyOf​(java.lang.Iterable<? extends java.util.Map.Entry<? extends K,​? extends V>> entries)
        Returns an immutable bimap containing the given entries. The returned bimap iterates over entries in the same order as the original iterable.
        Throws:
        java.lang.IllegalArgumentException - if two keys have the same value or two values have the same key
        java.lang.NullPointerException - if any key, value, or entry is null
        Since:
        19.0
      • inverse

        public abstract ImmutableBiMap<V,​Kinverse()
        Returns the inverse view of this bimap, which maps each of this bimap's values to its associated key. The two bimaps are backed by the same data; any changes to one will appear in the other.

        Note:There is no guaranteed correspondence between the iteration order of a bimap and that of its inverse.

        The inverse of an ImmutableBiMap is another ImmutableBiMap.

        Specified by:
        inverse in interface BiMap<K,​V>
        Returns:
        the inverse view of this bimap
      • forcePut

        @CanIgnoreReturnValue
        @Deprecated
        @CheckForNull
        public final V forcePut​(K key,
                                V value)
        Deprecated.
        Unsupported operation.
        Guaranteed to throw an exception and leave the bimap unmodified.
        Specified by:
        forcePut in interface BiMap<K,​V>
        Parameters:
        key - the key with which the specified value is to be associated
        value - the value to be associated with the specified key
        Returns:
        the value that was previously associated with the key, or null if there was no previous entry. (If the bimap contains null values, then forcePut, like put, returns null both if the key is absent and if it is present with a null value.)
        Throws:
        java.lang.UnsupportedOperationException - always