1 /*
2 * Copyright (C) 2009 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.google;
18
19 import static com.google.common.collect.testing.Helpers.mapEntry;
20
21 import com.google.common.annotations.GwtCompatible;
22 import com.google.common.collect.ImmutableMap;
23 import com.google.common.collect.ImmutableSet;
24 import com.google.common.collect.Iterables;
25 import com.google.common.collect.Maps;
26 import com.google.common.collect.Ordering;
27 import com.google.common.collect.testing.AnEnum;
28 import com.google.common.collect.testing.SampleElements;
29 import com.google.common.collect.testing.TestEnumMapGenerator;
30 import com.google.common.collect.testing.TestListGenerator;
31 import com.google.common.collect.testing.TestMapGenerator;
32 import com.google.common.collect.testing.TestStringListGenerator;
33 import com.google.common.collect.testing.TestStringMapGenerator;
34 import com.google.common.collect.testing.TestUnhashableCollectionGenerator;
35 import com.google.common.collect.testing.UnhashableObject;
36 import java.util.Arrays;
37 import java.util.Collection;
38 import java.util.EnumMap;
39 import java.util.List;
40 import java.util.Map;
41 import java.util.Map.Entry;
42
43 /**
44 * Generators of different types of map and related collections, such as keys, entries and values.
45 *
46 * @author Hayward Chan
47 */
48 @GwtCompatible
49 public class MapGenerators {
50 public static class ImmutableMapGenerator extends TestStringMapGenerator {
51 @Override
52 protected Map<String, String> create(Entry<String, String>[] entries) {
53 ImmutableMap.Builder<String, String> builder = ImmutableMap.builder();
54 for (Entry<String, String> entry : entries) {
55 builder.put(entry.getKey(), entry.getValue());
56 }
57 return builder.build();
58 }
59 }
60
61 public static class ImmutableMapCopyOfGenerator extends TestStringMapGenerator {
62 @Override
63 protected Map<String, String> create(Entry<String, String>[] entries) {
64 Map<String, String> builder = Maps.newLinkedHashMap();
65 for (Entry<String, String> entry : entries) {
66 builder.put(entry.getKey(), entry.getValue());
67 }
68 return ImmutableMap.copyOf(builder);
69 }
70 }
71
72 public static class ImmutableMapCopyOfEntriesGenerator extends TestStringMapGenerator {
73 @Override
74 protected Map<String, String> create(Entry<String, String>[] entries) {
75 return ImmutableMap.copyOf(Arrays.asList(entries));
76 }
77 }
78
79 public static class ImmutableMapUnhashableValuesGenerator
80 extends TestUnhashableCollectionGenerator<Collection<UnhashableObject>> {
81
82 @Override
83 public Collection<UnhashableObject> create(UnhashableObject[] elements) {
84 ImmutableMap.Builder<Integer, UnhashableObject> builder = ImmutableMap.builder();
85 int key = 1;
86 for (UnhashableObject value : elements) {
87 builder.put(key++, value);
88 }
89 return builder.build().values();
90 }
91 }
92
93 public static class ImmutableMapKeyListGenerator extends TestStringListGenerator {
94 @Override
95 public List<String> create(String[] elements) {
96 ImmutableMap.Builder<String, Integer> builder = ImmutableMap.builder();
97 for (int i = 0; i < elements.length; i++) {
98 builder.put(elements[i], i);
99 }
100 return builder.build().keySet().asList();
101 }
102 }
103
104 public static class ImmutableMapValueListGenerator extends TestStringListGenerator {
105 @Override
106 public List<String> create(String[] elements) {
107 ImmutableMap.Builder<Integer, String> builder = ImmutableMap.builder();
108 for (int i = 0; i < elements.length; i++) {
109 builder.put(i, elements[i]);
110 }
111 return builder.build().values().asList();
112 }
113 }
114
115 public static class ImmutableMapEntryListGenerator
116 implements TestListGenerator<Entry<String, Integer>> {
117
118 @Override
119 public SampleElements<Entry<String, Integer>> samples() {
120 return new SampleElements<>(
121 mapEntry("foo", 5),
122 mapEntry("bar", 3),
123 mapEntry("baz", 17),
124 mapEntry("quux", 1),
125 mapEntry("toaster", -2));
126 }
127
128 @SuppressWarnings("unchecked")
129 @Override
130 public Entry<String, Integer>[] createArray(int length) {
131 return new Entry[length];
132 }
133
134 @Override
135 public Iterable<Entry<String, Integer>> order(List<Entry<String, Integer>> insertionOrder) {
136 return insertionOrder;
137 }
138
139 @Override
140 public List<Entry<String, Integer>> create(Object... elements) {
141 ImmutableMap.Builder<String, Integer> builder = ImmutableMap.builder();
142 for (Object o : elements) {
143 @SuppressWarnings("unchecked")
144 Entry<String, Integer> entry = (Entry<String, Integer>) o;
145 builder.put(entry);
146 }
147 return builder.build().entrySet().asList();
148 }
149 }
150
151 public static class ImmutableEnumMapGenerator extends TestEnumMapGenerator {
152 @Override
153 protected Map<AnEnum, String> create(Entry<AnEnum, String>[] entries) {
154 Map<AnEnum, String> map = Maps.newHashMap();
155 for (Entry<AnEnum, String> entry : entries) {
156 // checkArgument(!map.containsKey(entry.getKey()));
157 map.put(entry.getKey(), entry.getValue());
158 }
159 return Maps.immutableEnumMap(map);
160 }
161 }
162
163 public static class ImmutableMapCopyOfEnumMapGenerator extends TestEnumMapGenerator {
164 @Override
165 protected Map<AnEnum, String> create(Entry<AnEnum, String>[] entries) {
166 EnumMap<AnEnum, String> map = new EnumMap<>(AnEnum.class);
167 for (Entry<AnEnum, String> entry : entries) {
168 map.put(entry.getKey(), entry.getValue());
169 }
170 return ImmutableMap.copyOf(map);
171 }
172
173 @Override
174 public Iterable<Entry<AnEnum, String>> order(List<Entry<AnEnum, String>> insertionOrder) {
175 return new Ordering<Entry<AnEnum, String>>() {
176
177 @Override
178 public int compare(Entry<AnEnum, String> left, Entry<AnEnum, String> right) {
179 return left.getKey().compareTo(right.getKey());
180 }
181 }.sortedCopy(insertionOrder);
182 }
183 }
184
185 public static class ImmutableMapValuesAsSingletonSetGenerator
186 implements TestMapGenerator<String, Collection<Integer>> {
187
188 @Override
189 public SampleElements<Entry<String, Collection<Integer>>> samples() {
190 return new SampleElements<>(
191 mapEntry("one", collectionOf(10000)),
192 mapEntry("two", collectionOf(-2000)),
193 mapEntry("three", collectionOf(300)),
194 mapEntry("four", collectionOf(-40)),
195 mapEntry("five", collectionOf(5)));
196 }
197
198 // javac7 can't infer the type parameters correctly in samples()
199 private static Collection<Integer> collectionOf(int item) {
200 return ImmutableSet.of(item);
201 }
202
203 @Override
204 public Map<String, Collection<Integer>> create(Object... elements) {
205 ImmutableMap.Builder<String, Integer> builder = ImmutableMap.builder();
206 // assumes that each set is a singleton or less (as is done for the samples)
207 for (Object elem : elements) {
208 @SuppressWarnings("unchecked") // safe by generator contract
209 Entry<String, Collection<Integer>> entry = (Entry<String, Collection<Integer>>) elem;
210 Integer value = Iterables.getOnlyElement(entry.getValue());
211 builder.put(entry.getKey(), value);
212 }
213 return builder.build().asMultimap().asMap();
214 }
215
216 @Override
217 @SuppressWarnings({"unchecked", "rawtypes"}) // needed for arrays
218 public Entry<String, Collection<Integer>>[] createArray(int length) {
219 return new Entry[length];
220 }
221
222 @Override
223 public Iterable<Entry<String, Collection<Integer>>> order(
224 List<Entry<String, Collection<Integer>>> insertionOrder) {
225 return insertionOrder;
226 }
227
228 @Override
229 public String[] createKeyArray(int length) {
230 return new String[length];
231 }
232
233 @Override
234 @SuppressWarnings({"unchecked", "rawtypes"}) // needed for arrays
235 public ImmutableSet<Integer>[] createValueArray(int length) {
236 return new ImmutableSet[length];
237 }
238 }
239 }