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.checkerframework.checker.nullness.qual.Nullable;
033import org.junit.Ignore;
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(emulated = true)
042@Ignore("test runners must not instantiate and run this directly, only via suites we build")
043// @Ignore affects the Android test runner, which respects JUnit 4 annotations on JUnit 3 tests.
044@SuppressWarnings("JUnit4ClassUsedInJUnit3")
045@ElementTypesAreNonnullByDefault
046public class MultisetIteratorTester<E extends @Nullable Object> extends AbstractMultisetTester<E> {
047  @CollectionFeature.Require({SUPPORTS_ITERATOR_REMOVE, KNOWN_ORDER})
048  public void testRemovingIteratorKnownOrder() {
049    new IteratorTester<E>(
050        4,
051        MODIFIABLE,
052        getSubjectGenerator().order(asList(e0(), e1(), e1(), e2())),
053        IteratorTester.KnownOrder.KNOWN_ORDER) {
054      @Override
055      protected Iterator<E> newTargetIterator() {
056        return getSubjectGenerator().create(e0(), e1(), e1(), e2()).iterator();
057      }
058    }.test();
059  }
060
061  @CollectionFeature.Require(value = SUPPORTS_ITERATOR_REMOVE, absent = KNOWN_ORDER)
062  public void testRemovingIteratorUnknownOrder() {
063    new IteratorTester<E>(
064        4, MODIFIABLE, asList(e0(), e1(), e1(), e2()), IteratorTester.KnownOrder.UNKNOWN_ORDER) {
065      @Override
066      protected Iterator<E> newTargetIterator() {
067        return getSubjectGenerator().create(e0(), e1(), e1(), e2()).iterator();
068      }
069    }.test();
070  }
071
072  @CollectionFeature.Require(value = KNOWN_ORDER, absent = SUPPORTS_ITERATOR_REMOVE)
073  public void testIteratorKnownOrder() {
074    new IteratorTester<E>(
075        4,
076        UNMODIFIABLE,
077        getSubjectGenerator().order(asList(e0(), e1(), e1(), e2())),
078        IteratorTester.KnownOrder.KNOWN_ORDER) {
079      @Override
080      protected Iterator<E> newTargetIterator() {
081        return getSubjectGenerator().create(e0(), e1(), e1(), e2()).iterator();
082      }
083    }.test();
084  }
085
086  @CollectionFeature.Require(absent = {SUPPORTS_ITERATOR_REMOVE, KNOWN_ORDER})
087  public void testIteratorUnknownOrder() {
088    new IteratorTester<E>(
089        4, UNMODIFIABLE, asList(e0(), e1(), e1(), e2()), IteratorTester.KnownOrder.UNKNOWN_ORDER) {
090      @Override
091      protected Iterator<E> newTargetIterator() {
092        return getSubjectGenerator().create(e0(), e1(), e1(), e2()).iterator();
093      }
094    }.test();
095  }
096
097  /**
098   * Returns {@link Method} instances for the tests that assume multisets support duplicates so that
099   * the test of {@code Multisets.forSet()} can suppress them.
100   */
101  @J2ktIncompatible
102  @GwtIncompatible // reflection
103  public static List<Method> getIteratorDuplicateInitializingMethods() {
104    return asList(
105        getMethod(MultisetIteratorTester.class, "testIteratorKnownOrder"),
106        getMethod(MultisetIteratorTester.class, "testIteratorUnknownOrder"),
107        getMethod(MultisetIteratorTester.class, "testRemovingIteratorKnownOrder"),
108        getMethod(MultisetIteratorTester.class, "testRemovingIteratorUnknownOrder"));
109  }
110}