com.google.common.collect.ForwardingMultimap Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-collections Show documentation

Google Collections Library is a suite of new collections and collection-related goodness for Java 5.0

There is a newer version: 1.0

/*
 * Copyright (C) 2007 Google Inc.
 *
 * 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.base.Nullable;

import java.util.Collection;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;

/**
 * A multimap which forwards all its method calls to another multimap.
 * Subclasses should override one or more methods to modify the behavior of
 * the backing multimap as desired per the decorator pattern.
 *
 * @see ForwardingObject
 * @author Robert Konigsberg
 */
public abstract class ForwardingMultimap extends ForwardingObject
    implements Multimap {

  @Override protected abstract Multimap delegate();

  public Map> asMap() {
    return delegate().asMap();
  }

  public void clear() {
    delegate().clear();
  }

  public boolean containsEntry(@Nullable Object key, @Nullable Object value) {
    return delegate().containsEntry(key, value);
  }

  public boolean containsKey(@Nullable Object key) {
    return delegate().containsKey(key);
  }

  public boolean containsValue(@Nullable Object value) {
    return delegate().containsValue(value);
  }

  public Collection> entries() {
    return delegate().entries();
  }

  public Collection get(@Nullable K key) {
    return delegate().get(key);
  }

  public boolean isEmpty() {
    return delegate().isEmpty();
  }

  public Multiset keys() {
    return delegate().keys();
  }

  public Set keySet() {
    return delegate().keySet();
  }

  public boolean put(K key, V value) {
    return delegate().put(key, value);
  }

  public boolean putAll(K key, Iterable values) {
    return delegate().putAll(key, values);
  }

  public boolean putAll(Multimap multimap) {
    return delegate().putAll(multimap);
  }

  public boolean remove(@Nullable Object key, @Nullable Object value) {
    return delegate().remove(key, value);
  }

  public Collection removeAll(@Nullable Object key) {
    return delegate().removeAll(key);
  }

  public Collection replaceValues(K key, Iterable values) {
    return delegate().replaceValues(key, values);
  }

  public int size() {
    return delegate().size();
  }

  public Collection values() {
    return delegate().values();
  }

  @Override public boolean equals(@Nullable Object obj) {
    return (this == obj) || delegate().equals(obj);
  }

  @Override public int hashCode() {
    return delegate().hashCode();
  }
}