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