aboutsummaryrefslogtreecommitdiffstats
path: root/guava-testlib/src/com/google/common/collect/testing/TestSortedMapGenerator.java
blob: 9a9ab73e07acbdd921a81c29a9c2365bacbb0a14 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
/*
 * Copyright (C) 2012 The Guava Authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.google.common.collect.testing;

import com.google.common.annotations.GwtCompatible;

import java.util.Map;
import java.util.SortedMap;

/**
 * Creates sorted maps, containing sample elements, to be tested.
 *
 * <p>This class is GWT compatible.
 * 
 * @author Louis Wasserman
 */
@GwtCompatible
public interface TestSortedMapGenerator<K, V> extends TestMapGenerator<K, V> {
  @Override
  SortedMap<K, V> create(Object... elements);
  
  /**
   * Returns an entry with a key less than the keys of the {@link #samples()}
   * and less than the key of {@link #belowSamplesGreater()}.
   */
  Map.Entry<K, V> belowSamplesLesser();
  
  /**
   * Returns an entry with a key less than the keys of the {@link #samples()}
   * but greater than the key of {@link #belowSamplesLesser()}.
   */
  Map.Entry<K, V> belowSamplesGreater();
  
  /**
   * Returns an entry with a key greater than the keys of the {@link #samples()}
   * but less than the key of {@link #aboveSamplesGreater()}.
   */
  Map.Entry<K, V> aboveSamplesLesser();
  
  /**
   * Returns an entry with a key greater than the keys of the {@link #samples()}
   * and greater than the key of {@link #aboveSamplesLesser()}.
   */
  Map.Entry<K, V> aboveSamplesGreater();
}