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@ElementTypesAreNonnullByDefault
044public class MultisetIteratorTester<E extends @Nullable Object> extends AbstractMultisetTester<E> {
045  @CollectionFeature.Require({SUPPORTS_ITERATOR_REMOVE, KNOWN_ORDER})
046  public void testRemovingIteratorKnownOrder() {
047    new IteratorTester<E>(
048        4,
049        MODIFIABLE,
050        getSubjectGenerator().order(Arrays.asList(e0(), e1(), e1(), e2())),
051        IteratorTester.KnownOrder.KNOWN_ORDER) {
052      @Override
053      protected Iterator<E> newTargetIterator() {
054        return getSubjectGenerator().create(e0(), e1(), e1(), e2()).iterator();
055      }
056    }.test();
057  }
058
059  @CollectionFeature.Require(value = SUPPORTS_ITERATOR_REMOVE, absent = KNOWN_ORDER)
060  public void testRemovingIteratorUnknownOrder() {
061    new IteratorTester<E>(
062        4,
063        MODIFIABLE,
064        Arrays.asList(e0(), e1(), e1(), e2()),
065        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(Arrays.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,
091        UNMODIFIABLE,
092        Arrays.asList(e0(), e1(), e1(), e2()),
093        IteratorTester.KnownOrder.UNKNOWN_ORDER) {
094      @Override
095      protected Iterator<E> newTargetIterator() {
096        return getSubjectGenerator().create(e0(), e1(), e1(), e2()).iterator();
097      }
098    }.test();
099  }
100
101  /**
102   * Returns {@link Method} instances for the tests that assume multisets support duplicates so that
103   * the test of {@code Multisets.forSet()} can suppress them.
104   */
105  @J2ktIncompatible
106  @GwtIncompatible // reflection
107  public static List<Method> getIteratorDuplicateInitializingMethods() {
108    return Arrays.asList(
109        Helpers.getMethod(MultisetIteratorTester.class, "testIteratorKnownOrder"),
110        Helpers.getMethod(MultisetIteratorTester.class, "testIteratorUnknownOrder"),
111        Helpers.getMethod(MultisetIteratorTester.class, "testRemovingIteratorKnownOrder"),
112        Helpers.getMethod(MultisetIteratorTester.class, "testRemovingIteratorUnknownOrder"));
113  }
114}