Package com.google.common.collect

Class ForwardingListMultimap<K,​V>

  • All Implemented Interfaces:
    ListMultimap<K,​V>, Multimap<K,​V>
    @GwtCompatible
public abstract class ForwardingListMultimap<K,​V>
extends ForwardingMultimap<K,​V>
implements ListMultimap<K,​V>
    A list multimap which forwards all its method calls to another list multimap. Subclasses should override one or more methods to modify the behavior of the backing multimap as desired per the decorator pattern.
    Since:
    3.0

    • Method Detail

      • get

        public java.util.List<V> get​(@Nullable
                             K key)
        Description copied from interface: Multimap
        Returns a collection view containing the values associated with key in this multimap, if any. Note that even when (containsKey(key) is false, get(key) still returns an empty collection, not null.

        Changes to the returned collection will update the underlying multimap, and vice versa.

        Specified by:
        get in interface ListMultimap<K,​V>
        Specified by:
        get in interface Multimap<K,​V>
        Overrides:
        get in class ForwardingMultimap<K,​V>
        Parameters:
        key - key to search for in multimap
        Returns:
        a view collection containing the zero or more values that the key maps to

      • removeAll

        public java.util.List<V> removeAll​(@Nullable
                                   java.lang.Object key)
        Description copied from interface: Multimap
        Removes all values associated with a given key.

        Once this method returns, key will not be mapped to any values, so it will not appear in Multimap.keySet(), Multimap.asMap(), or any other views.

        Specified by:
        removeAll in interface ListMultimap<K,​V>
        Specified by:
        removeAll in interface Multimap<K,​V>
        Overrides:
        removeAll in class ForwardingMultimap<K,​V>
        Parameters:
        key - key of entries to remove from the multimap
        Returns:
        the collection of removed values, or an empty collection if no values were associated with the provided key. The collection may be modifiable, but updating it will have no effect on the multimap.

      • replaceValues

        public java.util.List<V> replaceValues​(K key,
                                       java.lang.Iterable<? extends V> values)
        Description copied from interface: Multimap
        Stores a collection of values with the same key, replacing any existing values for that key.

        If values is empty, this is equivalent to removeAll(key).

        Specified by:
        replaceValues in interface ListMultimap<K,​V>
        Specified by:
        replaceValues in interface Multimap<K,​V>
        Overrides:
        replaceValues in class ForwardingMultimap<K,​V>
        Parameters:
        key - key to store in the multimap
        values - values to store in the multimap
        Returns:
        the collection of replaced values, or an empty collection if no values were previously associated with the key. The collection may be modifiable, but updating it will have no effect on the multimap.