Java

1
/*
2
 * Copyright (C) 2007 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.testers;
18

19
import static com.google.common.collect.testing.features.CollectionSize.ONE;
20
import static com.google.common.collect.testing.features.CollectionSize.ZERO;
21
import static com.google.common.collect.testing.features.MapFeature.ALLOWS_NULL_KEYS;
22
import static com.google.common.collect.testing.features.MapFeature.ALLOWS_NULL_VALUES;
23
import static com.google.common.collect.testing.features.MapFeature.REJECTS_DUPLICATES_AT_CREATION;
24

25
import com.google.common.annotations.GwtCompatible;
26
import com.google.common.annotations.GwtIncompatible;
27
import com.google.common.annotations.J2ktIncompatible;
28
import com.google.common.collect.testing.AbstractMapTester;
29
import com.google.common.collect.testing.Helpers;
30
import com.google.common.collect.testing.features.CollectionSize;
31
import com.google.common.collect.testing.features.MapFeature;
32
import java.lang.reflect.Method;
33
import java.util.Arrays;
34
import java.util.List;
35
import java.util.Map.Entry;
36
import org.junit.Ignore;
37

38
/**
39
 * A generic JUnit test which tests creation (typically through a constructor or static factory
40
 * method) of a map. Can't be invoked directly; please see {@link
41
 * com.google.common.collect.testing.MapTestSuiteBuilder}.
42
 *
43
 * @author Chris Povirk
44
 * @author Kevin Bourrillion
45
 */
46
@GwtCompatible(emulated = true)
47
@Ignore // Affects only Android test runner, which respects JUnit 4 annotations on JUnit 3 tests.
48
@SuppressWarnings("JUnit4ClassUsedInJUnit3")
49
public class MapCreationTester<K, V> extends AbstractMapTester<K, V> {
50
  @MapFeature.Require(ALLOWS_NULL_KEYS)
51
  @CollectionSize.Require(absent = ZERO)
52
  public void testCreateWithNullKeySupported() {
53
    initMapWithNullKey();
54
    expectContents(createArrayWithNullKey());
55
  }
56

57
  @MapFeature.Require(absent = ALLOWS_NULL_KEYS)
58
  @CollectionSize.Require(absent = ZERO)
59
  public void testCreateWithNullKeyUnsupported() {
60
    try {
61
      initMapWithNullKey();
62
      fail("Creating a map containing a null key should fail");
63
    } catch (NullPointerException expected) {
64
    }
65
  }
66

67
  @MapFeature.Require(ALLOWS_NULL_VALUES)
68
  @CollectionSize.Require(absent = ZERO)
69
  public void testCreateWithNullValueSupported() {
70
    initMapWithNullValue();
71
    expectContents(createArrayWithNullValue());
72
  }
73

74
  @MapFeature.Require(absent = ALLOWS_NULL_VALUES)
75
  @CollectionSize.Require(absent = ZERO)
76
  public void testCreateWithNullValueUnsupported() {
77
    try {
78
      initMapWithNullValue();
79
      fail("Creating a map containing a null value should fail");
80
    } catch (NullPointerException expected) {
81
    }
82
  }
83

84
  @MapFeature.Require({ALLOWS_NULL_KEYS, ALLOWS_NULL_VALUES})
85
  @CollectionSize.Require(absent = ZERO)
86
  public void testCreateWithNullKeyAndValueSupported() {
87
    Entry<K, V>[] entries = createSamplesArray();
88
    entries[getNullLocation()] = entry(null, null);
89
    resetMap(entries);
90
    expectContents(entries);
91
  }
92

93
  @MapFeature.Require(value = ALLOWS_NULL_KEYS, absent = REJECTS_DUPLICATES_AT_CREATION)
94
  @CollectionSize.Require(absent = {ZERO, ONE})
95
  public void testCreateWithDuplicates_nullDuplicatesNotRejected() {
96
    expectFirstRemoved(getEntriesMultipleNullKeys());
97
  }
98

99
  @MapFeature.Require(absent = REJECTS_DUPLICATES_AT_CREATION)
100
  @CollectionSize.Require(absent = {ZERO, ONE})
101
  public void testCreateWithDuplicates_nonNullDuplicatesNotRejected() {
102
    expectFirstRemoved(getEntriesMultipleNonNullKeys());
103
  }
104

105
  @MapFeature.Require({ALLOWS_NULL_KEYS, REJECTS_DUPLICATES_AT_CREATION})
106
  @CollectionSize.Require(absent = {ZERO, ONE})
107
  public void testCreateWithDuplicates_nullDuplicatesRejected() {
108
    Entry<K, V>[] entries = getEntriesMultipleNullKeys();
109
    try {
110
      resetMap(entries);
111
      fail("Should reject duplicate null elements at creation");
112
    } catch (IllegalArgumentException expected) {
113
    }
114
  }
115

116
  @MapFeature.Require(REJECTS_DUPLICATES_AT_CREATION)
117
  @CollectionSize.Require(absent = {ZERO, ONE})
118
  public void testCreateWithDuplicates_nonNullDuplicatesRejected() {
119
    Entry<K, V>[] entries = getEntriesMultipleNonNullKeys();
120
    try {
121
      resetMap(entries);
122
      fail("Should reject duplicate non-null elements at creation");
123
    } catch (IllegalArgumentException expected) {
124
    }
125
  }
126

127
  private Entry<K, V>[] getEntriesMultipleNullKeys() {
128
    Entry<K, V>[] entries = createArrayWithNullKey();
129
    entries[0] = entry(null, entries[0].getValue());
130
    return entries;
131
  }
132

133
  private Entry<K, V>[] getEntriesMultipleNonNullKeys() {
134
    Entry<K, V>[] entries = createSamplesArray();
135
    entries[0] = entry(k1(), v0());
136
    return entries;
137
  }
138

139
  private void expectFirstRemoved(Entry<K, V>[] entries) {
140
    resetMap(entries);
141

142
    List<Entry<K, V>> expectedWithDuplicateRemoved =
143
        Arrays.asList(entries).subList(1, getNumElements());
144
    expectContents(expectedWithDuplicateRemoved);
145
  }
146

147
  /**
148
   * Returns the {@link Method} instance for {@link #testCreateWithNullKeyUnsupported()} so that
149
   * tests can suppress it with {@code FeatureSpecificTestSuiteBuilder.suppressing()} until <a
150
   * href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=5045147">Sun bug 5045147</a> is fixed.
151
   */
152
  @J2ktIncompatible
153
  @GwtIncompatible // reflection
154
  public static Method getCreateWithNullKeyUnsupportedMethod() {
155
    return Helpers.getMethod(MapCreationTester.class, "testCreateWithNullKeyUnsupported");
156
  }
157
}
158