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.features.CollectionSize.ZERO;
018import static com.google.common.collect.testing.features.MapFeature.ALLOWS_NULL_KEYS;
019import static com.google.common.collect.testing.features.MapFeature.ALLOWS_NULL_VALUES;
020
021import com.google.common.annotations.GwtCompatible;
022import com.google.common.collect.Multimap;
023import com.google.common.collect.testing.Helpers;
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 // Affects only Android test runner, which respects JUnit 4 annotations on JUnit 3 tests.
040@ElementTypesAreNonnullByDefault
041public class MultimapEqualsTester<K extends @Nullable Object, V extends @Nullable Object>
042    extends AbstractMultimapTester<K, V, Multimap<K, V>> {
043  public void testEqualsTrue() {
044    new EqualsTester()
045        .addEqualityGroup(multimap(), getSubjectGenerator().create(getSampleElements().toArray()))
046        .testEquals();
047  }
048
049  public void testEqualsFalse() {
050    List<Entry<K, V>> targetEntries = new ArrayList<>(getSampleElements());
051    targetEntries.add(Helpers.mapEntry(k0(), v3()));
052    new EqualsTester()
053        .addEqualityGroup(multimap())
054        .addEqualityGroup(getSubjectGenerator().create(targetEntries.toArray()))
055        .testEquals();
056  }
057
058  @CollectionSize.Require(absent = ZERO)
059  @MapFeature.Require(ALLOWS_NULL_KEYS)
060  public void testEqualsMultimapWithNullKey() {
061    Multimap<K, V> original = multimap();
062    initMultimapWithNullKey();
063    Multimap<K, V> withNull = multimap();
064    new EqualsTester()
065        .addEqualityGroup(original)
066        .addEqualityGroup(
067            withNull, getSubjectGenerator().create((Object[]) createArrayWithNullKey()))
068        .testEquals();
069  }
070
071  @CollectionSize.Require(absent = ZERO)
072  @MapFeature.Require(ALLOWS_NULL_VALUES)
073  public void testEqualsMultimapWithNullValue() {
074    Multimap<K, V> original = multimap();
075    initMultimapWithNullValue();
076    Multimap<K, V> withNull = multimap();
077    new EqualsTester()
078        .addEqualityGroup(original)
079        .addEqualityGroup(
080            withNull, getSubjectGenerator().create((Object[]) createArrayWithNullValue()))
081        .testEquals();
082  }
083
084  @CollectionSize.Require(absent = ZERO)
085  public void testNotEqualsEmpty() {
086    new EqualsTester()
087        .addEqualityGroup(multimap())
088        .addEqualityGroup(getSubjectGenerator().create())
089        .testEquals();
090  }
091
092  public void testHashCodeMatchesAsMap() {
093    assertEquals(multimap().asMap().hashCode(), multimap().hashCode());
094  }
095}