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