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.IteratorFeature.MODIFIABLE;
018import static com.google.common.collect.testing.IteratorFeature.UNMODIFIABLE;
019import static com.google.common.collect.testing.features.CollectionFeature.KNOWN_ORDER;
020import static com.google.common.collect.testing.features.CollectionFeature.SUPPORTS_ITERATOR_REMOVE;
021
022import com.google.common.annotations.GwtCompatible;
023import com.google.common.annotations.GwtIncompatible;
024import com.google.common.annotations.J2ktIncompatible;
025import com.google.common.collect.testing.Helpers;
026import com.google.common.collect.testing.IteratorTester;
027import com.google.common.collect.testing.features.CollectionFeature;
028import java.lang.reflect.Method;
029import java.util.Arrays;
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 // Affects only Android test runner, which respects JUnit 4 annotations on JUnit 3 tests.
043@SuppressWarnings("JUnit4ClassUsedInJUnit3")
044@ElementTypesAreNonnullByDefault
045public class MultisetIteratorTester<E extends @Nullable Object> extends AbstractMultisetTester<E> {
046  @CollectionFeature.Require({SUPPORTS_ITERATOR_REMOVE, KNOWN_ORDER})
047  public void testRemovingIteratorKnownOrder() {
048    new IteratorTester<E>(
049        4,
050        MODIFIABLE,
051        getSubjectGenerator().order(Arrays.asList(e0(), e1(), e1(), e2())),
052        IteratorTester.KnownOrder.KNOWN_ORDER) {
053      @Override
054      protected Iterator<E> newTargetIterator() {
055        return getSubjectGenerator().create(e0(), e1(), e1(), e2()).iterator();
056      }
057    }.test();
058  }
059
060  @CollectionFeature.Require(value = SUPPORTS_ITERATOR_REMOVE, absent = KNOWN_ORDER)
061  public void testRemovingIteratorUnknownOrder() {
062    new IteratorTester<E>(
063        4,
064        MODIFIABLE,
065        Arrays.asList(e0(), e1(), e1(), e2()),
066        IteratorTester.KnownOrder.UNKNOWN_ORDER) {
067      @Override
068      protected Iterator<E> newTargetIterator() {
069        return getSubjectGenerator().create(e0(), e1(), e1(), e2()).iterator();
070      }
071    }.test();
072  }
073
074  @CollectionFeature.Require(value = KNOWN_ORDER, absent = SUPPORTS_ITERATOR_REMOVE)
075  public void testIteratorKnownOrder() {
076    new IteratorTester<E>(
077        4,
078        UNMODIFIABLE,
079        getSubjectGenerator().order(Arrays.asList(e0(), e1(), e1(), e2())),
080        IteratorTester.KnownOrder.KNOWN_ORDER) {
081      @Override
082      protected Iterator<E> newTargetIterator() {
083        return getSubjectGenerator().create(e0(), e1(), e1(), e2()).iterator();
084      }
085    }.test();
086  }
087
088  @CollectionFeature.Require(absent = {SUPPORTS_ITERATOR_REMOVE, KNOWN_ORDER})
089  public void testIteratorUnknownOrder() {
090    new IteratorTester<E>(
091        4,
092        UNMODIFIABLE,
093        Arrays.asList(e0(), e1(), e1(), e2()),
094        IteratorTester.KnownOrder.UNKNOWN_ORDER) {
095      @Override
096      protected Iterator<E> newTargetIterator() {
097        return getSubjectGenerator().create(e0(), e1(), e1(), e2()).iterator();
098      }
099    }.test();
100  }
101
102  /**
103   * Returns {@link Method} instances for the tests that assume multisets support duplicates so that
104   * the test of {@code Multisets.forSet()} can suppress them.
105   */
106  @J2ktIncompatible
107  @GwtIncompatible // reflection
108  public static List<Method> getIteratorDuplicateInitializingMethods() {
109    return Arrays.asList(
110        Helpers.getMethod(MultisetIteratorTester.class, "testIteratorKnownOrder"),
111        Helpers.getMethod(MultisetIteratorTester.class, "testIteratorUnknownOrder"),
112        Helpers.getMethod(MultisetIteratorTester.class, "testRemovingIteratorKnownOrder"),
113        Helpers.getMethod(MultisetIteratorTester.class, "testRemovingIteratorUnknownOrder"));
114  }
115}