Class EnumBiMap<K extends java.lang.Enum<K>,​V extends java.lang.Enum<V>>

  • All Implemented Interfaces:
    BiMap<K,​V>, java.io.Serializable, java.util.Map<K,​V>

    @GwtCompatible(emulated=true)
    public final class EnumBiMap<K extends java.lang.Enum<K>,​V extends java.lang.Enum<V>>
    extends ForwardingMap<K,​V>
    A BiMap backed by two EnumMap instances. Null keys and values are not permitted. An EnumBiMap and its inverse are both serializable.

    See the Guava User Guide article on BiMap.

    Since:
    2.0 (imported from Google Collections Library)
    See Also:
    Serialized Form
    • Nested Class Summary

      • 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 Concrete Methods 
      Modifier and Type Method Description
      void clear()  
      boolean containsValue​(java.lang.Object value)  
      static <K extends java.lang.Enum<K>,​V extends java.lang.Enum<V>>
      EnumBiMap<K,​V>
      create​(java.lang.Class<K> keyType, java.lang.Class<V> valueType)
      Returns a new, empty EnumBiMap using the specified key and value types.
      static <K extends java.lang.Enum<K>,​V extends java.lang.Enum<V>>
      EnumBiMap<K,​V>
      create​(java.util.Map<K,​V> map)
      Returns a new bimap with the same mappings as the specified map.
      java.util.Set<java.util.Map.Entry<K,​V>> entrySet()  
      V forcePut​(K key, V value)
      An alternate form of put that silently removes any existing entry with the value value before proceeding with the BiMap.put(K, V) operation.
      BiMap<V,​K> inverse()
      Returns the inverse view of this bimap, which maps each of this bimap's values to its associated key.
      java.util.Set<K> keySet()  
      java.lang.Class<K> keyType()
      Returns the associated key type.
      V put​(K key, V value)
      void putAll​(java.util.Map<? extends K,​? extends V> map)
      V remove​(java.lang.Object key)  
      java.util.Set<V> values()
      java.lang.Class<V> valueType()
      Returns the associated value type.
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
      • Methods inherited from interface java.util.Map

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

      • create

        public static <K extends java.lang.Enum<K>,​V extends java.lang.Enum<V>> EnumBiMap<K,​V> create​(java.lang.Class<K> keyType,
                                                                                                                  java.lang.Class<V> valueType)
        Returns a new, empty EnumBiMap using the specified key and value types.
        Parameters:
        keyType - the key type
        valueType - the value type
      • create

        public static <K extends java.lang.Enum<K>,​V extends java.lang.Enum<V>> EnumBiMap<K,​V> create​(java.util.Map<K,​V> map)
        Returns a new bimap with the same mappings as the specified map. If the specified map is an EnumBiMap, the new bimap has the same types as the provided map. Otherwise, the specified map must contain at least one mapping, in order to determine the key and value types.
        Parameters:
        map - the map whose mappings are to be placed in this map
        Throws:
        java.lang.IllegalArgumentException - if map is not an EnumBiMap instance and contains no mappings
      • keyType

        public java.lang.Class<K> keyType()
        Returns the associated key type.
      • valueType

        public java.lang.Class<V> valueType()
        Returns the associated value type.
      • containsValue

        public boolean containsValue​(@Nullable
                                     java.lang.Object value)
        Specified by:
        containsValue in interface java.util.Map<K,​V>
        Overrides:
        containsValue in class ForwardingMap<K,​V>
      • put

        public V put​(@Nullable
                     K key,
                     @Nullable
                     V value)
        Description copied from interface: BiMap
        Specified by:
        put in interface BiMap<K,​V>
        Specified by:
        put in interface java.util.Map<K,​V>
        Overrides:
        put in class ForwardingMap<K,​V>
      • forcePut

        public V forcePut​(@Nullable
                          K key,
                          @Nullable
                          V value)
        Description copied from interface: BiMap
        An alternate form of put that silently removes any existing entry with the value value before proceeding with the BiMap.put(K, V) operation. If the bimap previously contained the provided key-value mapping, this method has no effect.

        Note that a successful call to this method could cause the size of the bimap to increase by one, stay the same, or even decrease by one.

        Warning: If an existing entry with this value is removed, the key for that entry is discarded and not returned.

        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 which was previously associated with the key, which may be null, or null if there was no previous entry
      • remove

        public V remove​(@Nullable
                        java.lang.Object key)
        Specified by:
        remove in interface java.util.Map<K,​V>
        Overrides:
        remove in class ForwardingMap<K,​V>
      • putAll

        public void putAll​(java.util.Map<? extends K,​? extends V> map)
        Description copied from interface: BiMap

        Warning: the results of calling this method may vary depending on the iteration order of map.

        Specified by:
        putAll in interface BiMap<K,​V>
        Specified by:
        putAll in interface java.util.Map<K,​V>
        Overrides:
        putAll in class ForwardingMap<K,​V>
      • clear

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

        public BiMap<V,​K> inverse()
        Description copied from interface: BiMap
        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.

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

        public java.util.Set<K> keySet()
        Specified by:
        keySet in interface java.util.Map<K,​V>
        Overrides:
        keySet in class ForwardingMap<K,​V>
      • values

        public java.util.Set<V> values()
        Description copied from interface: BiMap

        Because a bimap has unique values, this method returns a Set, instead of the Collection specified in the Map interface.

        Specified by:
        values in interface BiMap<K,​V>
        Specified by:
        values in interface java.util.Map<K,​V>
        Overrides:
        values in class ForwardingMap<K,​V>
      • entrySet

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