com.google.common.collect.ForwardingSetMultimap Maven / Gradle / Ivy
Show all versions of guava Show documentation
/*
* Copyright (C) 2010 The Guava Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.common.collect;
import com.google.common.annotations.GwtCompatible;
import com.google.errorprone.annotations.CanIgnoreReturnValue;
import java.util.Map.Entry;
import java.util.Set;
import javax.annotation.CheckForNull;
import org.checkerframework.checker.nullness.qual.Nullable;
/**
* 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.
*
* {@code default} method warning: This class does not forward calls to {@code
* default} methods. Instead, it inherits their default implementations. When those implementations
* invoke methods, they invoke methods on the {@code ForwardingSetMultimap}.
*
* @author Kurt Alfred Kluever
* @since 3.0
*/
@GwtCompatible
@ElementTypesAreNonnullByDefault
public abstract class ForwardingSetMultimap
extends ForwardingMultimap implements SetMultimap {
@Override
protected abstract SetMultimap delegate();
@Override
public Set> entries() {
return delegate().entries();
}
@Override
public Set get(@ParametricNullness K key) {
return delegate().get(key);
}
@CanIgnoreReturnValue
@Override
public Set removeAll(@CheckForNull Object key) {
return delegate().removeAll(key);
}
@CanIgnoreReturnValue
@Override
public Set replaceValues(@ParametricNullness K key, Iterable values) {
return delegate().replaceValues(key, values);
}
}