1 /*
2  * Copyright (C) 2015 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.CollectionFeature.KNOWN_ORDER;
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 
24 import com.google.common.annotations.GwtCompatible;
25 import com.google.common.collect.testing.AbstractMapTester;
26 import com.google.common.collect.testing.Helpers;
27 import com.google.common.collect.testing.features.CollectionFeature;
28 import com.google.common.collect.testing.features.CollectionSize;
29 import com.google.common.collect.testing.features.MapFeature;
30 import java.util.ArrayList;
31 import java.util.Arrays;
32 import java.util.List;
33 import java.util.Map;
34 import java.util.Map.Entry;
35 import org.junit.Ignore;
36 
37 /**
38  * A generic JUnit test which tests {@link Map#forEach}. Can't be invoked directly; please see
39  * {@link com.google.common.collect.testing.MapTestSuiteBuilder}.
40  *
41  * @author Louis Wasserman
42  */
43 @GwtCompatible
44 @Ignore // Affects only Android test runner, which respects JUnit 4 annotations on JUnit 3 tests.
45 public class MapForEachTester<K, V> extends AbstractMapTester<K, V> {
46   @CollectionFeature.Require(KNOWN_ORDER)
testForEachKnownOrder()47   public void testForEachKnownOrder() {
48     List<Entry<K, V>> entries = new ArrayList<>();
49     getMap().forEach((k, v) -> entries.add(entry(k, v)));
50     assertEquals(getOrderedElements(), entries);
51   }
52 
53   @CollectionFeature.Require(absent = KNOWN_ORDER)
testForEachUnknownOrder()54   public void testForEachUnknownOrder() {
55     List<Entry<K, V>> entries = new ArrayList<>();
56     getMap().forEach((k, v) -> entries.add(entry(k, v)));
57     Helpers.assertEqualIgnoringOrder(getSampleEntries(), entries);
58   }
59 
60   @MapFeature.Require(ALLOWS_NULL_KEYS)
61   @CollectionSize.Require(absent = ZERO)
testForEach_nullKeys()62   public void testForEach_nullKeys() {
63     initMapWithNullKey();
64     List<Entry<K, V>> expectedEntries = Arrays.asList(createArrayWithNullKey());
65     List<Entry<K, V>> entries = new ArrayList<>();
66     getMap().forEach((k, v) -> entries.add(entry(k, v)));
67     Helpers.assertEqualIgnoringOrder(expectedEntries, entries);
68   }
69 
70   @MapFeature.Require(ALLOWS_NULL_VALUES)
71   @CollectionSize.Require(absent = ZERO)
testForEach_nullValues()72   public void testForEach_nullValues() {
73     initMapWithNullValue();
74     List<Entry<K, V>> expectedEntries = Arrays.asList(createArrayWithNullValue());
75     List<Entry<K, V>> entries = new ArrayList<>();
76     getMap().forEach((k, v) -> entries.add(entry(k, v)));
77     Helpers.assertEqualIgnoringOrder(expectedEntries, entries);
78   }
79 }
80