001/*
002 * Copyright (C) 2011 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.getMethod;
018import static com.google.common.collect.testing.IteratorFeature.MODIFIABLE;
019import static com.google.common.collect.testing.IteratorFeature.UNMODIFIABLE;
020import static com.google.common.collect.testing.features.CollectionFeature.KNOWN_ORDER;
021import static com.google.common.collect.testing.features.CollectionFeature.SUPPORTS_ITERATOR_REMOVE;
022import static java.util.Arrays.asList;
023
024import com.google.common.annotations.GwtCompatible;
025import com.google.common.annotations.GwtIncompatible;
026import com.google.common.annotations.J2ktIncompatible;
027import com.google.common.collect.testing.IteratorTester;
028import com.google.common.collect.testing.features.CollectionFeature;
029import java.lang.reflect.Method;
030import java.util.Iterator;
031import java.util.List;
032import org.jspecify.annotations.NullMarked;
033import org.jspecify.annotations.Nullable;
034import org.junit.Ignore;
035
036/**
037 * Tester to make sure the {@code iterator().remove()} implementation of {@code Multiset} works when
038 * there are multiple occurrences of elements.
039 *
040 * @author Louis Wasserman
041 */
042@GwtCompatible(emulated = true)
043@Ignore("test runners must not instantiate and run this directly, only via suites we build")
044// @Ignore affects the Android test runner, which respects JUnit 4 annotations on JUnit 3 tests.
045@SuppressWarnings("JUnit4ClassUsedInJUnit3")
046@NullMarked
047public class MultisetIteratorTester<E extends @Nullable Object> extends AbstractMultisetTester<E> {
048  @CollectionFeature.Require({SUPPORTS_ITERATOR_REMOVE, KNOWN_ORDER})
049  public void testRemovingIteratorKnownOrder() {
050    new IteratorTester<E>(
051        4,
052        MODIFIABLE,
053        getSubjectGenerator().order(asList(e0(), e1(), e1(), e2())),
054        IteratorTester.KnownOrder.KNOWN_ORDER) {
055      @Override
056      protected Iterator<E> newTargetIterator() {
057        return getSubjectGenerator().create(e0(), e1(), e1(), e2()).iterator();
058      }
059    }.test();
060  }
061
062  @CollectionFeature.Require(value = SUPPORTS_ITERATOR_REMOVE, absent = KNOWN_ORDER)
063  public void testRemovingIteratorUnknownOrder() {
064    new IteratorTester<E>(
065        4, MODIFIABLE, asList(e0(), e1(), e1(), e2()), IteratorTester.KnownOrder.UNKNOWN_ORDER) {
066      @Override
067      protected Iterator<E> newTargetIterator() {
068        return getSubjectGenerator().create(e0(), e1(), e1(), e2()).iterator();
069      }
070    }.test();
071  }
072
073  @CollectionFeature.Require(value = KNOWN_ORDER, absent = SUPPORTS_ITERATOR_REMOVE)
074  public void testIteratorKnownOrder() {
075    new IteratorTester<E>(
076        4,
077        UNMODIFIABLE,
078        getSubjectGenerator().order(asList(e0(), e1(), e1(), e2())),
079        IteratorTester.KnownOrder.KNOWN_ORDER) {
080      @Override
081      protected Iterator<E> newTargetIterator() {
082        return getSubjectGenerator().create(e0(), e1(), e1(), e2()).iterator();
083      }
084    }.test();
085  }
086
087  @CollectionFeature.Require(absent = {SUPPORTS_ITERATOR_REMOVE, KNOWN_ORDER})
088  public void testIteratorUnknownOrder() {
089    new IteratorTester<E>(
090        4, UNMODIFIABLE, asList(e0(), e1(), e1(), e2()), IteratorTester.KnownOrder.UNKNOWN_ORDER) {
091      @Override
092      protected Iterator<E> newTargetIterator() {
093        return getSubjectGenerator().create(e0(), e1(), e1(), e2()).iterator();
094      }
095    }.test();
096  }
097
098  /**
099   * Returns {@link Method} instances for the tests that assume multisets support duplicates so that
100   * the test of {@code Multisets.forSet()} can suppress them.
101   */
102  @J2ktIncompatible
103  @GwtIncompatible // reflection
104  public static List<Method> getIteratorDuplicateInitializingMethods() {
105    return asList(
106        getMethod(MultisetIteratorTester.class, "testIteratorKnownOrder"),
107        getMethod(MultisetIteratorTester.class, "testIteratorUnknownOrder"),
108        getMethod(MultisetIteratorTester.class, "testRemovingIteratorKnownOrder"),
109        getMethod(MultisetIteratorTester.class, "testRemovingIteratorUnknownOrder"));
110  }
111}