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:
Serializable, Map<K,V>, BiMap<K,V>
public final class HashBiMap<K,V> extends AbstractMap<K,V> implements BiMap<K,V>, 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:

  • 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:
      IllegalArgumentException - if the specified expected size is negative

    • create

      public static <K, V> HashBiMap<K,V> create(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 Object key)
      Specified by:
      containsKey in interface Map<K,V>
      Overrides:
      containsKey in class AbstractMap<K,V>

    • containsValue

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

    • get

      public @Nullable V get(@Nullable Object key)
      Specified by:
      get in interface Map<K,V>
      Overrides:
      get in class 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 Map<K,V>
      Overrides:
      put in class 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 Object key)
      Specified by:
      remove in interface Map<K,V>
      Overrides:
      remove in class AbstractMap<K,V>

    • clear

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

    • size

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

    • keySet

      public Set<K> keySet()
      Specified by:
      keySet in interface Map<K,V>
      Overrides:
      keySet in class AbstractMap<K,V>

    • values

      public 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 Map<K,V>
      Overrides:
      values in class AbstractMap<K,V>

    • forEach

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

    • replaceAll

      public void replaceAll(BiFunction<? super K,? super V,? extends V> function)
      Specified by:
      replaceAll in interface 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 Set<Map.Entry<K,V>> entrySet()
      Specified by:
      entrySet in interface Map<K,V>
      Specified by:
      entrySet in class AbstractMap<K,V>