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

Go to download

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

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

The newest version!

/*
 * 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 java.util.Comparator;
import java.util.SortedMap;

/**
 * A sorted map which forwards all its method calls to another sorted map.
 * Subclasses should override one or more methods to modify the behavior of
 * the backing sorted map as desired per the decorator pattern.
 *
 * @see ForwardingObject
 * @author Mike Bostock
 */
public abstract class ForwardingSortedMap extends ForwardingMap
    implements SortedMap {

  /**
   * Constructs a forwarding sorted map that forwards to the provided delegate.
   */
  protected ForwardingSortedMap(SortedMap delegate) {
    super(delegate);
  }

  @SuppressWarnings("unchecked")
  @Override protected SortedMap delegate() {
    return (SortedMap) super.delegate();
  }

  public Comparator comparator() {
    return delegate().comparator();
  }

  public K firstKey() {
    return delegate().firstKey();
  }

  public SortedMap headMap(K toKey) {
    return delegate().headMap(toKey);
  }

  public K lastKey() {
    return delegate().lastKey();
  }

  public SortedMap subMap(K fromKey, K toKey) {
    return delegate().subMap(fromKey, toKey);
  }

  public SortedMap tailMap(K fromKey) {
    return delegate().tailMap(fromKey);
  }
}