001/*
002 * Copyright (C) 2015 The Guava Authors
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package com.google.common.collect.testing.testers;
018
019import static com.google.common.collect.testing.features.CollectionFeature.KNOWN_ORDER;
020import static com.google.common.collect.testing.features.CollectionSize.ZERO;
021import static com.google.common.collect.testing.features.MapFeature.ALLOWS_NULL_KEYS;
022import static com.google.common.collect.testing.features.MapFeature.ALLOWS_NULL_VALUES;
023
024import com.google.common.annotations.GwtCompatible;
025import com.google.common.collect.testing.AbstractMapTester;
026import com.google.common.collect.testing.Helpers;
027import com.google.common.collect.testing.features.CollectionFeature;
028import com.google.common.collect.testing.features.CollectionSize;
029import com.google.common.collect.testing.features.MapFeature;
030import java.util.ArrayList;
031import java.util.Arrays;
032import java.util.List;
033import java.util.Map;
034import java.util.Map.Entry;
035import org.junit.Ignore;
036
037/**
038 * A generic JUnit test which tests {@link Map#forEach}. Can't be invoked directly; please see
039 * {@link com.google.common.collect.testing.MapTestSuiteBuilder}.
040 *
041 * @author Louis Wasserman
042 */
043@GwtCompatible
044@Ignore // Affects only Android test runner, which respects JUnit 4 annotations on JUnit 3 tests.
045public class MapForEachTester<K, V> extends AbstractMapTester<K, V> {
046  @CollectionFeature.Require(KNOWN_ORDER)
047  public void testForEachKnownOrder() {
048    List<Entry<K, V>> entries = new ArrayList<>();
049    getMap().forEach((k, v) -> entries.add(entry(k, v)));
050    assertEquals(getOrderedElements(), entries);
051  }
052
053  @CollectionFeature.Require(absent = KNOWN_ORDER)
054  public void testForEachUnknownOrder() {
055    List<Entry<K, V>> entries = new ArrayList<>();
056    getMap().forEach((k, v) -> entries.add(entry(k, v)));
057    Helpers.assertEqualIgnoringOrder(getSampleEntries(), entries);
058  }
059
060  @MapFeature.Require(ALLOWS_NULL_KEYS)
061  @CollectionSize.Require(absent = ZERO)
062  public void testForEach_nullKeys() {
063    initMapWithNullKey();
064    List<Entry<K, V>> expectedEntries = Arrays.asList(createArrayWithNullKey());
065    List<Entry<K, V>> entries = new ArrayList<>();
066    getMap().forEach((k, v) -> entries.add(entry(k, v)));
067    Helpers.assertEqualIgnoringOrder(expectedEntries, entries);
068  }
069
070  @MapFeature.Require(ALLOWS_NULL_VALUES)
071  @CollectionSize.Require(absent = ZERO)
072  public void testForEach_nullValues() {
073    initMapWithNullValue();
074    List<Entry<K, V>> expectedEntries = Arrays.asList(createArrayWithNullValue());
075    List<Entry<K, V>> entries = new ArrayList<>();
076    getMap().forEach((k, v) -> entries.add(entry(k, v)));
077    Helpers.assertEqualIgnoringOrder(expectedEntries, entries);
078  }
079}