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.jspecify.annotations.NullMarked;
031import org.jspecify.annotations.Nullable;
032
033/**
034 * Tester for {@code Multimap.equals}.
035 *
036 * @author Louis Wasserman
037 */
038@GwtCompatible
039@NullMarked
040public class MultimapEqualsTester<K extends @Nullable Object, V extends @Nullable Object>
041    extends AbstractMultimapTester<K, V, Multimap<K, V>> {
042  public void testEqualsTrue() {
043    new EqualsTester()
044        .addEqualityGroup(multimap(), getSubjectGenerator().create(getSampleElements().toArray()))
045        .testEquals();
046  }
047
048  public void testEqualsFalse() {
049    List<Entry<K, V>> targetEntries = new ArrayList<>(getSampleElements());
050    targetEntries.add(mapEntry(k0(), v3()));
051    new EqualsTester()
052        .addEqualityGroup(multimap())
053        .addEqualityGroup(getSubjectGenerator().create(targetEntries.toArray()))
054        .testEquals();
055  }
056
057  @CollectionSize.Require(absent = ZERO)
058  @MapFeature.Require(ALLOWS_NULL_KEYS)
059  public void testEqualsMultimapWithNullKey() {
060    Multimap<K, V> original = multimap();
061    initMultimapWithNullKey();
062    Multimap<K, V> withNull = multimap();
063    new EqualsTester()
064        .addEqualityGroup(original)
065        .addEqualityGroup(
066            withNull, getSubjectGenerator().create((Object[]) createArrayWithNullKey()))
067        .testEquals();
068  }
069
070  @CollectionSize.Require(absent = ZERO)
071  @MapFeature.Require(ALLOWS_NULL_VALUES)
072  public void testEqualsMultimapWithNullValue() {
073    Multimap<K, V> original = multimap();
074    initMultimapWithNullValue();
075    Multimap<K, V> withNull = multimap();
076    new EqualsTester()
077        .addEqualityGroup(original)
078        .addEqualityGroup(
079            withNull, getSubjectGenerator().create((Object[]) createArrayWithNullValue()))
080        .testEquals();
081  }
082
083  @CollectionSize.Require(absent = ZERO)
084  public void testNotEqualsEmpty() {
085    new EqualsTester()
086        .addEqualityGroup(multimap())
087        .addEqualityGroup(getSubjectGenerator().create())
088        .testEquals();
089  }
090
091  public void testHashCodeMatchesAsMap() {
092    assertEquals(multimap().asMap().hashCode(), multimap().hashCode());
093  }
094}