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