com.google.common.collect.StandardSortedSetMultimap 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.SortedSet;

/**
 * Basic implementation of the {@link SortedSetMultimap} interface. It's a
 * wrapper around {@link StandardMultimap} that converts the returned
 * collections into sorted sets. The {@link #createCollection} method
 * must return a {@code SortedSet}.
 *
 * @author Jared Levy
 */
abstract class StandardSortedSetMultimap
    extends StandardSetMultimap implements SortedSetMultimap {
  /**
   * Creates a new multimap that uses the provided map.
   *
   * @param map place to store the mapping from each key to its corresponding
   *     values
   */
  protected StandardSortedSetMultimap(Map> map) {
    super(map);
  }

  @Override abstract SortedSet createCollection();

  @Override public SortedSet get(@Nullable K key) {
    return (SortedSet) super.get(key);
  }

  @Override public SortedSet removeAll(@Nullable Object key) {
    return (SortedSet) super.removeAll(key);
  }

  @Override public SortedSet replaceValues(
      K key, Iterable values) {
    return (SortedSet) super.replaceValues(key, values);
  }
  
  /**
   * {@inheritDoc}
   *
   * Consequently, the values do not follow their natural ordering or the
   * ordering of the value comparator.
   */
  @Override public Collection values() {
    return super.values();
  }  
}