001/*
002 * Copyright (C) 2013 The Guava Authors
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
005 * in compliance with the License. You may obtain a copy of the License at
006 *
007 * http://www.apache.org/licenses/LICENSE-2.0
008 *
009 * Unless required by applicable law or agreed to in writing, software distributed under the License
010 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
011 * or implied. See the License for the specific language governing permissions and limitations under
012 * the License.
013 */
014
015package com.google.common.collect.testing.google;
016
017import static com.google.common.collect.testing.Helpers.assertContainsAllOf;
018import static com.google.common.collect.testing.features.CollectionFeature.SUPPORTS_ITERATOR_REMOVE;
019import static com.google.common.collect.testing.features.CollectionSize.ONE;
020import static com.google.common.collect.testing.features.CollectionSize.SEVERAL;
021import static com.google.common.collect.testing.features.MapFeature.ALLOWS_NULL_KEYS;
022import static com.google.common.collect.testing.features.MapFeature.ALLOWS_NULL_KEY_QUERIES;
023import static com.google.common.collect.testing.features.MapFeature.SUPPORTS_REMOVE;
024
025import com.google.common.annotations.GwtCompatible;
026import com.google.common.collect.Multimap;
027import com.google.common.collect.Multiset;
028import com.google.common.collect.Multisets;
029import com.google.common.collect.testing.Helpers;
030import com.google.common.collect.testing.features.CollectionFeature;
031import com.google.common.collect.testing.features.CollectionSize;
032import com.google.common.collect.testing.features.MapFeature;
033import java.util.Iterator;
034import org.junit.Ignore;
035
036/**
037 * Tester for {@code Multimap.entries}.
038 *
039 * @author Louis Wasserman
040 */
041@GwtCompatible
042@Ignore // Affects only Android test runner, which respects JUnit 4 annotations on JUnit 3 tests.
043@SuppressWarnings("JUnit4ClassUsedInJUnit3")
044public class MultimapKeysTester<K, V> extends AbstractMultimapTester<K, V, Multimap<K, V>> {
045  @CollectionSize.Require(SEVERAL)
046  public void testKeys() {
047    resetContainer(
048        Helpers.mapEntry(k0(), v0()), Helpers.mapEntry(k0(), v1()), Helpers.mapEntry(k1(), v0()));
049    Multiset<K> keys = multimap().keys();
050    assertEquals(2, keys.count(k0()));
051    assertEquals(1, keys.count(k1()));
052    assertEquals(3, keys.size());
053    assertContainsAllOf(keys, k0(), k1());
054    assertContainsAllOf(
055        keys.entrySet(), Multisets.immutableEntry(k0(), 2), Multisets.immutableEntry(k1(), 1));
056  }
057
058  @MapFeature.Require(ALLOWS_NULL_KEY_QUERIES)
059  public void testKeysCountAbsentNullKey() {
060    assertEquals(0, multimap().keys().count(null));
061  }
062
063  @CollectionSize.Require(SEVERAL)
064  @MapFeature.Require(ALLOWS_NULL_KEYS)
065  public void testKeysWithNullKey() {
066    resetContainer(
067        Helpers.mapEntry((K) null, v0()),
068        Helpers.mapEntry((K) null, v1()),
069        Helpers.mapEntry(k1(), v0()));
070    Multiset<K> keys = multimap().keys();
071    assertEquals(2, keys.count(null));
072    assertEquals(1, keys.count(k1()));
073    assertEquals(3, keys.size());
074    assertContainsAllOf(keys, null, k1());
075    assertContainsAllOf(
076        keys.entrySet(), Multisets.immutableEntry((K) null, 2), Multisets.immutableEntry(k1(), 1));
077  }
078
079  public void testKeysElementSet() {
080    assertEquals(multimap().keySet(), multimap().keys().elementSet());
081  }
082
083  @MapFeature.Require(SUPPORTS_REMOVE)
084  public void testKeysRemove() {
085    int original = multimap().keys().remove(k0(), 1);
086    assertEquals(Math.max(original - 1, 0), multimap().get(k0()).size());
087  }
088
089  @CollectionSize.Require(ONE)
090  @CollectionFeature.Require(SUPPORTS_ITERATOR_REMOVE)
091  public void testKeysEntrySetIteratorRemove() {
092    Multiset<K> keys = multimap().keys();
093    Iterator<Multiset.Entry<K>> itr = keys.entrySet().iterator();
094    assertEquals(Multisets.immutableEntry(k0(), 1), itr.next());
095    itr.remove();
096    assertTrue(multimap().isEmpty());
097  }
098
099  @CollectionSize.Require(SEVERAL)
100  @MapFeature.Require(SUPPORTS_REMOVE)
101  public void testKeysEntrySetRemove() {
102    resetContainer(
103        Helpers.mapEntry(k0(), v0()), Helpers.mapEntry(k0(), v1()), Helpers.mapEntry(k1(), v0()));
104    assertTrue(multimap().keys().entrySet().remove(Multisets.immutableEntry(k0(), 2)));
105    assertEquals(1, multimap().size());
106    assertTrue(multimap().containsEntry(k1(), v0()));
107  }
108}