Package com.google.common.collect

Class HashBiMap<K extends @Nullable Object,​V extends @Nullable Object>

    • Method Detail

      • create

        public static <K extends @Nullable Object,​V extends @Nullable Object> 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.

      • containsValue

        public boolean containsValue​(@CheckForNull
                             Object value)
        Returns true if this BiMap contains an entry whose value is equal to value (or, equivalently, if this inverse view contains a key that is equal to value).

        Due to the property that values in a BiMap are unique, this will tend to execute in faster-than-linear time.

        Specified by:
        containsValue in interface Map<K extends @Nullable Object,​V extends @Nullable Object>
        Overrides:
        containsValue in class AbstractMap<K extends @Nullable Object,​V extends @Nullable Object>
        Parameters:
        value - the object to search for in the values of this BiMap
        Returns:
        true if a mapping exists from a key to the specified value

      • get

        @CheckForNull
public V get​(@CheckForNull
             Object key)
        Description copied from class: java.util.AbstractMap
        Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key.

        More formally, if this map contains a mapping from a key k to a value v such that Objects.equals(key, k), then this method returns v; otherwise it returns null. (There can be at most one such mapping.)

        If this map permits null values, then a return value of null does not necessarily indicate that the map contains no mapping for the key; it's also possible that the map explicitly maps the key to null. The containsKey operation may be used to distinguish these two cases.

        Specified by:
        get in interface Map<K extends @Nullable Object,​V extends @Nullable Object>
        Overrides:
        get in class AbstractMap<K extends @Nullable Object,​V extends @Nullable Object>
        Parameters:
        key - the key whose associated value is to be returned
        Returns:
        the value to which the specified key is mapped, or null if this map contains no mapping for the key

      • put

        @CanIgnoreReturnValue
@CheckForNull
public V put​(K key,
             V value)
        Description copied from class: java.util.AbstractMap
        Associates the specified value with the specified key in this map (optional operation). If the map previously contained a mapping for the key, the old value is replaced by the specified value. (A map m is said to contain a mapping for a key k if and only if m.containsKey(k) would return true.)
        Specified by:
        put in interface BiMap<K extends @Nullable Object,​V extends @Nullable Object>
        Specified by:
        put in interface Map<K extends @Nullable Object,​V extends @Nullable Object>
        Overrides:
        put in class AbstractMap<K extends @Nullable Object,​V extends @Nullable Object>
        Parameters:
        key - key with which the specified value is to be associated
        value - value to be associated with the specified key
        Returns:
        the previous value associated with key, or null if there was no mapping for key. (A null return can also indicate that the map previously associated null with key, if the implementation supports null values.)

      • forcePut

        @CanIgnoreReturnValue
@CheckForNull
public V forcePut​(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 extends @Nullable Object,​V extends @Nullable Object>
        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.)

      • remove

        @CanIgnoreReturnValue
@CheckForNull
public V remove​(@CheckForNull
                Object key)
        Description copied from class: java.util.AbstractMap
        Removes the mapping for a key from this map if it is present (optional operation). More formally, if this map contains a mapping from key k to value v such that Objects.equals(key, k), that mapping is removed. (The map can contain at most one such mapping.)

        Returns the value to which this map previously associated the key, or null if the map contained no mapping for the key.

        If this map permits null values, then a return value of null does not necessarily indicate that the map contained no mapping for the key; it's also possible that the map explicitly mapped the key to null.

        The map will not contain a mapping for the specified key once the call returns.

        Specified by:
        remove in interface Map<K extends @Nullable Object,​V extends @Nullable Object>
        Overrides:
        remove in class AbstractMap<K extends @Nullable Object,​V extends @Nullable Object>
        Parameters:
        key - key whose mapping is to be removed from the map
        Returns:
        the previous value associated with key, or null if there was no mapping for key.

      • size

        public int size()
        Description copied from class: java.util.AbstractMap
        Returns the number of key-value mappings in this map. If the map contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.
        Specified by:
        size in interface Map<K extends @Nullable Object,​V extends @Nullable Object>
        Returns:
        the number of key-value mappings in this map

      • keySet

        public Set<K> keySet()
        Description copied from class: java.util.AbstractMap
        Returns a Set view of the keys contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll, retainAll, and clear operations. It does not support the add or addAll operations.
        Specified by:
        keySet in interface Map<K extends @Nullable Object,​V extends @Nullable Object>
        Overrides:
        keySet in class AbstractMap<K extends @Nullable Object,​V extends @Nullable Object>
        Returns:
        a set view of the keys contained in this map

      • values

        public Set<V> values()
        Description copied from class: java.util.AbstractMap
        Returns a Collection view of the values contained in this map. The collection is backed by the map, so changes to the map are reflected in the collection, and vice-versa. If the map is modified while an iteration over the collection is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The collection supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Collection.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.
        Specified by:
        values in interface BiMap<K extends @Nullable Object,​V extends @Nullable Object>
        Specified by:
        values in interface Map<K extends @Nullable Object,​V extends @Nullable Object>
        Overrides:
        values in class AbstractMap<K extends @Nullable Object,​V extends @Nullable Object>
        Returns:
        a collection view of the values contained in this map

      • forEach

        public void forEach​(BiConsumer<? super K,​? super V> action)
        Description copied from interface: java.util.Map
        Performs the given action for each entry in this map until all entries have been processed or the action throws an exception. Unless otherwise specified by the implementing class, actions are performed in the order of entry set iteration (if an iteration order is specified.) Exceptions thrown by the action are relayed to the caller.
        Specified by:
        forEach in interface Map<K extends @Nullable Object,​V extends @Nullable Object>
        Parameters:
        action - The action to be performed for each entry

      • replaceAll

        public void replaceAll​(BiFunction<? super K,​? super V,​? extends V> function)
        Description copied from interface: java.util.Map
        Replaces each entry's value with the result of invoking the given function on that entry until all entries have been processed or the function throws an exception. Exceptions thrown by the function are relayed to the caller.
        Specified by:
        replaceAll in interface Map<K extends @Nullable Object,​V extends @Nullable Object>
        Parameters:
        function - the function to apply to each entry

      • 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 extends @Nullable Object,​V extends @Nullable Object>
        Returns:
        the inverse view of this bimap

      • entrySet

        public Set<Map.Entry<K,​V>> entrySet()
        Description copied from interface: java.util.Map
        Returns a Set view of the mappings contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own remove operation, or through the setValue operation on a map entry returned by the iterator) the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.
        Specified by:
        entrySet in interface Map<K extends @Nullable Object,​V extends @Nullable Object>
        Specified by:
        entrySet in class AbstractMap<K extends @Nullable Object,​V extends @Nullable Object>
        Returns:
        a set view of the mappings contained in this map