Debian Codegraph @

guava-testlib/src/com/google/common/collect/testing/TestSortedMapGenerator.java

raw
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
17 package com.google.common.collect.testing;
18
19 import com.google.common.annotations.GwtCompatible;
20 import java.util.Map.Entry;
21 import java.util.SortedMap;
22
23 /**
24 * Creates sorted maps, containing sample elements, to be tested.
25 *
26 * @author Louis Wasserman
27 */
28 @GwtCompatible
29 public interface TestSortedMapGenerator<K, V> extends TestMapGenerator<K, V> {
30 @Override
31 SortedMap<K, V> create(Object... elements);
32
33 /**
34 * Returns an entry with a key less than the keys of the {@link #samples()} and less than the key
35 * of {@link #belowSamplesGreater()}.
36 */
37 Entry<K, V> belowSamplesLesser();
38
39 /**
40 * Returns an entry with a key less than the keys of the {@link #samples()} but greater than the
41 * key of {@link #belowSamplesLesser()}.
42 */
43 Entry<K, V> belowSamplesGreater();
44
45 /**
46 * Returns an entry with a key greater than the keys of the {@link #samples()} but less than the
47 * key of {@link #aboveSamplesGreater()}.
48 */
49 Entry<K, V> aboveSamplesLesser();
50
51 /**
52 * Returns an entry with a key greater than the keys of the {@link #samples()} and greater than
53 * the key of {@link #aboveSamplesLesser()}.
54 */
55 Entry<K, V> aboveSamplesGreater();
56 }