Package org.docx4j.com.google.common.collect

Class HashBiMap<K,​V>

java.lang.Object
java.util.AbstractMap<K,​V>
org.docx4j.com.google.common.collect.HashBiMap<K,​V>
All Implemented Interfaces:
java.io.Serializable, java.util.Map<K,​V>, BiMap<K,​V>
public final class HashBiMap<K,​V>
extends java.util.AbstractMap<K,​V>
implements BiMap<K,​V>, java.io.Serializable
A BiMap backed by two hash tables. This implementation allows null keys and values. A HashBiMap and its inverse are both serializable.

This implementation guarantees insertion-based iteration order of its keys.

See the Guava User Guide article on BiMap .

Since:
2.0
Author:
Louis Wasserman, Mike Bostock
See Also:
Serialized Form

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.util.AbstractMap

    java.util.AbstractMap.SimpleEntry<K extends java.lang.Object,​V extends java.lang.Object>, java.util.AbstractMap.SimpleImmutableEntry<K extends java.lang.Object,​V extends java.lang.Object>

    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

    Modifier and Type Method Description
    void clear()  
    boolean containsKey​(@Nullable java.lang.Object key)  
    boolean containsValue​(@Nullable java.lang.Object value)  
    static <K,​ V> HashBiMap<K,​V> create()
    Returns a new, empty HashBiMap with the default initial capacity (16).
    static <K,​ V> HashBiMap<K,​V> create​(int expectedSize)
    Constructs a new, empty bimap with the specified expected size.
    static <K,​ V> HashBiMap<K,​V> create​(java.util.Map<? extends K,​? extends V> map)
    Constructs a new bimap containing initial values from map.
    java.util.Set<java.util.Map.Entry<K,​V>> entrySet()  
    @Nullable V forcePut​(@Nullable K key, @Nullable 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.
    void forEach​(java.util.function.BiConsumer<? super K,​? super V> action)  
    @Nullable V get​(@Nullable java.lang.Object key)  
    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()  
    V put​(@Nullable K key, @Nullable V value)
    @Nullable V remove​(@Nullable java.lang.Object key)  
    void replaceAll​(java.util.function.BiFunction<? super K,​? super V,​? extends V> function)  
    int size()  
    java.util.Set<V> values()

    Methods inherited from class java.util.AbstractMap

    clone, equals, hashCode, isEmpty, putAll, toString

    Methods inherited from class java.lang.Object

    finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface org.docx4j.com.google.common.collect.BiMap

    putAll

    Methods inherited from interface java.util.Map

    compute, computeIfAbsent, computeIfPresent, entrySet, equals, getOrDefault, hashCode, isEmpty, merge, putIfAbsent, remove, replace, replace

  • Method Details

    • create

      public static <K,​ V> HashBiMap<K,​V> create()
      Returns a new, empty HashBiMap with the default initial capacity (16).

    • create

      public static <K,​ V> HashBiMap<K,​V> create​(int expectedSize)
      Constructs a new, empty bimap with the specified expected size.
      Parameters:
      expectedSize - the expected number of entries
      Throws:
      java.lang.IllegalArgumentException - if the specified expected size is negative

    • create

      public static <K,​ V> HashBiMap<K,​V> create​(java.util.Map<? extends K,​? extends V> map)
      Constructs a new bimap containing initial values from map. The bimap is created with an initial capacity sufficient to hold the mappings in the specified map.

    • containsKey

      public boolean containsKey​(@Nullable java.lang.Object key)
      Specified by:
      containsKey in interface java.util.Map<K,​V>
      Overrides:
      containsKey in class java.util.AbstractMap<K,​V>

    • containsValue

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

    • get

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

    • put

      @CanIgnoreReturnValue 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 java.util.AbstractMap<K,​V>

    • forcePut

      @CanIgnoreReturnValue public @Nullable 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

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

    • clear

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

    • size

      public int size()
      Specified by:
      size in interface java.util.Map<K,​V>

    • keySet

      public java.util.Set<K> keySet()
      Specified by:
      keySet in interface java.util.Map<K,​V>
      Overrides:
      keySet in class java.util.AbstractMap<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 java.util.AbstractMap<K,​V>

    • forEach

      public void forEach​(java.util.function.BiConsumer<? super K,​? super V> action)
      Specified by:
      forEach in interface java.util.Map<K,​V>

    • replaceAll

      public void replaceAll​(java.util.function.BiFunction<? super K,​? super V,​? extends V> function)
      Specified by:
      replaceAll in interface java.util.Map<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

    • entrySet

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