Class HashBiMap<K,​V>

    • Method Detail

      • 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.
        expectedSize - the expected number of entries
        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.
      • forcePut

        public V forcePut​(@Nullable
                          K key,
                          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>
        key - the key with which the specified value is to be associated
        value - the value to be associated with the specified key
        the value which was previously associated with the key, which may be null, or null if there was no previous entry
      • 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>
        values in class AbstractMap<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>
        the inverse view of this bimap