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@SuppressWarnings("JUnit4ClassUsedInJUnit3")
041@ElementTypesAreNonnullByDefault
042public class MultimapEqualsTester<K extends @Nullable Object, V extends @Nullable Object>
043    extends AbstractMultimapTester<K, V, Multimap<K, V>> {
044  public void testEqualsTrue() {
045    new EqualsTester()
046        .addEqualityGroup(multimap(), getSubjectGenerator().create(getSampleElements().toArray()))
047        .testEquals();
048  }
049
050  public void testEqualsFalse() {
051    List<Entry<K, V>> targetEntries = new ArrayList<>(getSampleElements());
052    targetEntries.add(Helpers.mapEntry(k0(), v3()));
053    new EqualsTester()
054        .addEqualityGroup(multimap())
055        .addEqualityGroup(getSubjectGenerator().create(targetEntries.toArray()))
056        .testEquals();
057  }
058
059  @CollectionSize.Require(absent = ZERO)
060  @MapFeature.Require(ALLOWS_NULL_KEYS)
061  public void testEqualsMultimapWithNullKey() {
062    Multimap<K, V> original = multimap();
063    initMultimapWithNullKey();
064    Multimap<K, V> withNull = multimap();
065    new EqualsTester()
066        .addEqualityGroup(original)
067        .addEqualityGroup(
068            withNull, getSubjectGenerator().create((Object[]) createArrayWithNullKey()))
069        .testEquals();
070  }
071
072  @CollectionSize.Require(absent = ZERO)
073  @MapFeature.Require(ALLOWS_NULL_VALUES)
074  public void testEqualsMultimapWithNullValue() {
075    Multimap<K, V> original = multimap();
076    initMultimapWithNullValue();
077    Multimap<K, V> withNull = multimap();
078    new EqualsTester()
079        .addEqualityGroup(original)
080        .addEqualityGroup(
081            withNull, getSubjectGenerator().create((Object[]) createArrayWithNullValue()))
082        .testEquals();
083  }
084
085  @CollectionSize.Require(absent = ZERO)
086  public void testNotEqualsEmpty() {
087    new EqualsTester()
088        .addEqualityGroup(multimap())
089        .addEqualityGroup(getSubjectGenerator().create())
090        .testEquals();
091  }
092
093  public void testHashCodeMatchesAsMap() {
094    assertEquals(multimap().asMap().hashCode(), multimap().hashCode());
095  }
096}