001/*
002 * Copyright (C) 2012 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.testing;
018
019import com.google.common.annotations.GwtCompatible;
020import java.util.Map.Entry;
021import java.util.SortedMap;
022import org.checkerframework.checker.nullness.qual.Nullable;
023
024/**
025 * Creates sorted maps, containing sample elements, to be tested.
026 *
027 * @author Louis Wasserman
028 */
029@GwtCompatible
030@ElementTypesAreNonnullByDefault
031public interface TestSortedMapGenerator<K extends @Nullable Object, V extends @Nullable Object>
032    extends TestMapGenerator<K, V> {
033  @Override
034  SortedMap<K, V> create(Object... elements);
035
036  /**
037   * Returns an entry with a key less than the keys of the {@link #samples()} and less than the key
038   * of {@link #belowSamplesGreater()}.
039   */
040  Entry<K, V> belowSamplesLesser();
041
042  /**
043   * Returns an entry with a key less than the keys of the {@link #samples()} but greater than the
044   * key of {@link #belowSamplesLesser()}.
045   */
046  Entry<K, V> belowSamplesGreater();
047
048  /**
049   * Returns an entry with a key greater than the keys of the {@link #samples()} but less than the
050   * key of {@link #aboveSamplesGreater()}.
051   */
052  Entry<K, V> aboveSamplesLesser();
053
054  /**
055   * Returns an entry with a key greater than the keys of the {@link #samples()} and greater than
056   * the key of {@link #aboveSamplesLesser()}.
057   */
058  Entry<K, V> aboveSamplesGreater();
059}