001/*
002 * Copyright (C) 2010 The Guava Authors
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package com.google.common.collect;
018
019import com.google.common.annotations.GwtCompatible;
020import com.google.errorprone.annotations.CanIgnoreReturnValue;
021import java.util.Map.Entry;
022import java.util.Set;
023import javax.annotation.Nullable;
024
025/**
026 * A set multimap which forwards all its method calls to another set multimap. Subclasses should
027 * override one or more methods to modify the behavior of the backing multimap as desired per the <a
028 * href="http://en.wikipedia.org/wiki/Decorator_pattern">decorator pattern</a>.
029 *
030 * <p><b>{@code default} method warning:</b> This class does <i>not</i> forward calls to {@code
031 * default} methods. Instead, it inherits their default implementations. When those implementations
032 * invoke methods, they invoke methods on the {@code ForwardingSetMultimap}.
033 *
034 * @author Kurt Alfred Kluever
035 * @since 3.0
036 */
037@GwtCompatible
038public abstract class ForwardingSetMultimap<K, V> extends ForwardingMultimap<K, V>
039    implements SetMultimap<K, V> {
040
041  @Override
042  protected abstract SetMultimap<K, V> delegate();
043
044  @Override
045  public Set<Entry<K, V>> entries() {
046    return delegate().entries();
047  }
048
049  @Override
050  public Set<V> get(@Nullable K key) {
051    return delegate().get(key);
052  }
053
054  @CanIgnoreReturnValue
055  @Override
056  public Set<V> removeAll(@Nullable Object key) {
057    return delegate().removeAll(key);
058  }
059
060  @CanIgnoreReturnValue
061  @Override
062  public Set<V> replaceValues(K key, Iterable<? extends V> values) {
063    return delegate().replaceValues(key, values);
064  }
065}