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;
034
035/**
036 * Tester to make sure the {@code iterator().remove()} implementation of {@code Multiset} works when
037 * there are multiple occurrences of elements.
038 *
039 * @author Louis Wasserman
040 */
041@GwtCompatible
042@NullMarked
043public class MultisetIteratorTester<E extends @Nullable Object> extends AbstractMultisetTester<E> {
044  @CollectionFeature.Require({SUPPORTS_ITERATOR_REMOVE, KNOWN_ORDER})
045  public void testRemovingIteratorKnownOrder() {
046    new IteratorTester<E>(
047        4,
048        MODIFIABLE,
049        getSubjectGenerator().order(asList(e0(), e1(), e1(), e2())),
050        IteratorTester.KnownOrder.KNOWN_ORDER) {
051      @Override
052      protected Iterator<E> newTargetIterator() {
053        return getSubjectGenerator().create(e0(), e1(), e1(), e2()).iterator();
054      }
055    }.test();
056  }
057
058  @CollectionFeature.Require(value = SUPPORTS_ITERATOR_REMOVE, absent = KNOWN_ORDER)
059  public void testRemovingIteratorUnknownOrder() {
060    new IteratorTester<E>(
061        4, MODIFIABLE, asList(e0(), e1(), e1(), e2()), IteratorTester.KnownOrder.UNKNOWN_ORDER) {
062      @Override
063      protected Iterator<E> newTargetIterator() {
064        return getSubjectGenerator().create(e0(), e1(), e1(), e2()).iterator();
065      }
066    }.test();
067  }
068
069  @CollectionFeature.Require(value = KNOWN_ORDER, absent = SUPPORTS_ITERATOR_REMOVE)
070  public void testIteratorKnownOrder() {
071    new IteratorTester<E>(
072        4,
073        UNMODIFIABLE,
074        getSubjectGenerator().order(asList(e0(), e1(), e1(), e2())),
075        IteratorTester.KnownOrder.KNOWN_ORDER) {
076      @Override
077      protected Iterator<E> newTargetIterator() {
078        return getSubjectGenerator().create(e0(), e1(), e1(), e2()).iterator();
079      }
080    }.test();
081  }
082
083  @CollectionFeature.Require(absent = {SUPPORTS_ITERATOR_REMOVE, KNOWN_ORDER})
084  public void testIteratorUnknownOrder() {
085    new IteratorTester<E>(
086        4, UNMODIFIABLE, asList(e0(), e1(), e1(), e2()), IteratorTester.KnownOrder.UNKNOWN_ORDER) {
087      @Override
088      protected Iterator<E> newTargetIterator() {
089        return getSubjectGenerator().create(e0(), e1(), e1(), e2()).iterator();
090      }
091    }.test();
092  }
093
094  /**
095   * Returns {@link Method} instances for the tests that assume multisets support duplicates so that
096   * the test of {@code Multisets.forSet()} can suppress them.
097   */
098  @J2ktIncompatible
099  @GwtIncompatible // reflection
100  public static List<Method> getIteratorDuplicateInitializingMethods() {
101    return asList(
102        getMethod(MultisetIteratorTester.class, "testIteratorKnownOrder"),
103        getMethod(MultisetIteratorTester.class, "testIteratorUnknownOrder"),
104        getMethod(MultisetIteratorTester.class, "testRemovingIteratorKnownOrder"),
105        getMethod(MultisetIteratorTester.class, "testRemovingIteratorUnknownOrder"));
106  }
107}