TestSortedMapGenerator.java revision 3c77433663281544363151bf284b0240dfd22a42 
1/*
2 * Copyright (C) 2012 The Guava Authors
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package com.google.common.collect.testing;
18
19import com.google.common.annotations.GwtCompatible;
20
21import java.util.Map;
22import java.util.SortedMap;
23
24/**
25 * Creates sorted maps, containing sample elements, to be tested.
26 *
27 * <p>This class is GWT compatible.
28 *
29 * @author Louis Wasserman
30 */
31@GwtCompatible
32public interface TestSortedMapGenerator<K, V> extends TestMapGenerator<K, V> {
33  @Override
34  SortedMap<K, V> create(Object... elements);
35
36  /**
37   * Returns an entry with a key less than the keys of the {@link #samples()}
38   * and less than the key of {@link #belowSamplesGreater()}.
39   */
40  Map.Entry<K, V> belowSamplesLesser();
41
42  /**
43   * Returns an entry with a key less than the keys of the {@link #samples()}
44   * but greater than the key of {@link #belowSamplesLesser()}.
45   */
46  Map.Entry<K, V> belowSamplesGreater();
47
48  /**
49   * Returns an entry with a key greater than the keys of the {@link #samples()}
50   * but less than the key of {@link #aboveSamplesGreater()}.
51   */
52  Map.Entry<K, V> aboveSamplesLesser();
53
54  /**
55   * Returns an entry with a key greater than the keys of the {@link #samples()}
56   * and greater than the key of {@link #aboveSamplesLesser()}.
57   */
58  Map.Entry<K, V> aboveSamplesGreater();
59}
60