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.mapEntry;
018import static com.google.common.collect.testing.features.CollectionSize.ZERO;
019import static com.google.common.collect.testing.features.MapFeature.ALLOWS_NULL_KEYS;
020import static com.google.common.collect.testing.features.MapFeature.ALLOWS_NULL_VALUES;
021
022import com.google.common.annotations.GwtCompatible;
023import com.google.common.collect.Multimap;
024import com.google.common.collect.testing.features.CollectionSize;
025import com.google.common.collect.testing.features.MapFeature;
026import com.google.common.testing.EqualsTester;
027import java.util.ArrayList;
028import java.util.List;
029import java.util.Map.Entry;
030import org.checkerframework.checker.nullness.qual.Nullable;
031import org.junit.Ignore;
032
033/**
034 * Tester for {@code Multimap.equals}.
035 *
036 * @author Louis Wasserman
037 */
038@GwtCompatible
039@Ignore("test runners must not instantiate and run this directly, only via suites we build")
040// @Ignore affects the Android test runner, which respects JUnit 4 annotations on JUnit 3 tests.
041@SuppressWarnings("JUnit4ClassUsedInJUnit3")
042@ElementTypesAreNonnullByDefault
043public class MultimapEqualsTester<K extends @Nullable Object, V extends @Nullable Object>
044    extends AbstractMultimapTester<K, V, Multimap<K, V>> {
045  public void testEqualsTrue() {
046    new EqualsTester()
047        .addEqualityGroup(multimap(), getSubjectGenerator().create(getSampleElements().toArray()))
048        .testEquals();
049  }
050
051  public void testEqualsFalse() {
052    List<Entry<K, V>> targetEntries = new ArrayList<>(getSampleElements());
053    targetEntries.add(mapEntry(k0(), v3()));
054    new EqualsTester()
055        .addEqualityGroup(multimap())
056        .addEqualityGroup(getSubjectGenerator().create(targetEntries.toArray()))
057        .testEquals();
058  }
059
060  @CollectionSize.Require(absent = ZERO)
061  @MapFeature.Require(ALLOWS_NULL_KEYS)
062  public void testEqualsMultimapWithNullKey() {
063    Multimap<K, V> original = multimap();
064    initMultimapWithNullKey();
065    Multimap<K, V> withNull = multimap();
066    new EqualsTester()
067        .addEqualityGroup(original)
068        .addEqualityGroup(
069            withNull, getSubjectGenerator().create((Object[]) createArrayWithNullKey()))
070        .testEquals();
071  }
072
073  @CollectionSize.Require(absent = ZERO)
074  @MapFeature.Require(ALLOWS_NULL_VALUES)
075  public void testEqualsMultimapWithNullValue() {
076    Multimap<K, V> original = multimap();
077    initMultimapWithNullValue();
078    Multimap<K, V> withNull = multimap();
079    new EqualsTester()
080        .addEqualityGroup(original)
081        .addEqualityGroup(
082            withNull, getSubjectGenerator().create((Object[]) createArrayWithNullValue()))
083        .testEquals();
084  }
085
086  @CollectionSize.Require(absent = ZERO)
087  public void testNotEqualsEmpty() {
088    new EqualsTester()
089        .addEqualityGroup(multimap())
090        .addEqualityGroup(getSubjectGenerator().create())
091        .testEquals();
092  }
093
094  public void testHashCodeMatchesAsMap() {
095    assertEquals(multimap().asMap().hashCode(), multimap().hashCode());
096  }
097}