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 java.util.Map;
021import java.util.Set;
022import java.util.SortedMap;
023import java.util.SortedSet;
024import org.jspecify.annotations.Nullable;
025
026/**
027 * Interface that extends {@code Table} and whose rows are sorted.
028 *
029 * <p>The {@link #rowKeySet} method returns a {@link SortedSet} and the {@link #rowMap} method
030 * returns a {@link SortedMap}, instead of the {@link Set} and {@link Map} specified by the {@link
031 * Table} interface.
032 *
033 * @author Warren Dukes
034 * @since 8.0
035 */
036@GwtCompatible
037public interface RowSortedTable<
038        R extends @Nullable Object, C extends @Nullable Object, V extends @Nullable Object>
039    extends Table<R, C, V> {
040  /**
041   * {@inheritDoc}
042   *
043   * <p>This method returns a {@link SortedSet}, instead of the {@code Set} specified in the {@link
044   * Table} interface.
045   */
046  @Override
047  SortedSet<R> rowKeySet();
048
049  /**
050   * {@inheritDoc}
051   *
052   * <p>This method returns a {@link SortedMap}, instead of the {@code Map} specified in the {@link
053   * Table} interface.
054   */
055  @Override
056  SortedMap<R, Map<C, V>> rowMap();
057}