Package com.google.common.collect

Class ForwardingSetMultimap<K,V>

java.lang.Object
com.google.common.collect.ForwardingObject
com.google.common.collect.ForwardingMultimap<K,V>
com.google.common.collect.ForwardingSetMultimap<K,V>
All Implemented Interfaces:
Multimap<K,V>, SetMultimap<K,V>
Direct Known Subclasses:
ForwardingSortedSetMultimap
@GwtCompatible @Deprecated(since="2022-12-01") public abstract class ForwardingSetMultimap<K,V> extends ForwardingMultimap<K,V> implements SetMultimap<K,V>
Deprecated.
The Google Guava Core Libraries are deprecated and will not be part of the AEM SDK after April 2023
A set multimap which forwards all its method calls to another set 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

  • Constructor Details

    • ForwardingSetMultimap

      public ForwardingSetMultimap()
      Deprecated.

  • Method Details

    • entries

      public Set<Map.Entry<K,V>> entries()
      Deprecated.
      Description copied from interface: Multimap
      Returns a collection of all key-value pairs. Changes to the returned collection will update the underlying multimap, and vice versa. The entries collection does not support the add or addAll operations.
      Specified by:
      entries in interface Multimap<K,V>
      Specified by:
      entries in interface SetMultimap<K,V>
      Overrides:
      entries in class ForwardingMultimap<K,V>
      Returns:
      collection of map entries consisting of key-value pairs

    • get

      public Set<V> get(@Nullable K key)
      Deprecated.
      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 Multimap<K,V>
      Specified by:
      get in interface SetMultimap<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 Set<V> removeAll(@Nullable Object key)
      Deprecated.
      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 Multimap<K,V>
      Specified by:
      removeAll in interface SetMultimap<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 Set<V> replaceValues(K key, Iterable<? extends V> values)
      Deprecated.
      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 Multimap<K,V>
      Specified by:
      replaceValues in interface SetMultimap<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.