1 /*
2 * Copyright (C) 2010 The Guava Authors
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17 package com.google.common.collect;
18
19 import com.google.common.annotations.GwtCompatible;
20 import com.google.errorprone.annotations.CanIgnoreReturnValue;
21 import java.util.Map.Entry;
22 import java.util.Set;
23 import org.checkerframework.checker.nullness.qual.Nullable;
24
25 /**
26 * A set multimap which forwards all its method calls to another set multimap. Subclasses should
27 * override one or more methods to modify the behavior of the backing multimap as desired per the <a
28 * href="http://en.wikipedia.org/wiki/Decorator_pattern">decorator pattern</a>.
29 *
30 * <p><b>{@code default} method warning:</b> This class does <i>not</i> forward calls to {@code
31 * default} methods. Instead, it inherits their default implementations. When those implementations
32 * invoke methods, they invoke methods on the {@code ForwardingSetMultimap}.
33 *
34 * @author Kurt Alfred Kluever
35 * @since 3.0
36 */
37 @GwtCompatible
38 public abstract class ForwardingSetMultimap<K, V> extends ForwardingMultimap<K, V>
39 implements SetMultimap<K, V> {
40
41 @Override
42 protected abstract SetMultimap<K, V> delegate();
43
44 @Override
45 public Set<Entry<K, V>> entries() {
46 return delegate().entries();
47 }
48
49 @Override
50 public Set<V> get(@Nullable K key) {
51 return delegate().get(key);
52 }
53
54 @CanIgnoreReturnValue
55 @Override
56 public Set<V> removeAll(@Nullable Object key) {
57 return delegate().removeAll(key);
58 }
59
60 @CanIgnoreReturnValue
61 @Override
62 public Set<V> replaceValues(K key, Iterable<? extends V> values) {
63 return delegate().replaceValues(key, values);
64 }
65 }