001/*
002 * Copyright (C) 2013 The Guava Authors
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package com.google.common.collect.testing.testers;
018
019import static com.google.common.collect.testing.features.CollectionFeature.ALLOWS_NULL_VALUES;
020import static com.google.common.collect.testing.features.CollectionFeature.KNOWN_ORDER;
021import static com.google.common.collect.testing.features.CollectionFeature.SUPPORTS_ADD;
022import static com.google.common.collect.testing.features.CollectionFeature.SUPPORTS_REMOVE;
023import static com.google.common.collect.testing.features.CollectionSize.ZERO;
024
025import com.google.common.annotations.GwtCompatible;
026import com.google.common.annotations.GwtIncompatible;
027import com.google.common.collect.testing.AbstractCollectionTester;
028import com.google.common.collect.testing.Helpers;
029import com.google.common.collect.testing.SpliteratorTester;
030import com.google.common.collect.testing.features.CollectionFeature;
031import com.google.common.collect.testing.features.CollectionSize;
032import java.lang.reflect.Method;
033import java.util.Spliterator;
034import org.junit.Ignore;
035
036/**
037 * A generic JUnit test which tests {@code spliterator} operations on a collection. Can't be invoked
038 * directly; please see {@link com.google.common.collect.testing.CollectionTestSuiteBuilder}.
039 *
040 * @author Louis Wasserman
041 */
042@GwtCompatible(emulated = true)
043@Ignore // Affects only Android test runner, which respects JUnit 4 annotations on JUnit 3 tests.
044public class CollectionSpliteratorTester<E> extends AbstractCollectionTester<E> {
045
046  @CollectionFeature.Require(absent = KNOWN_ORDER)
047  public void testSpliteratorUnknownOrder() {
048    synchronized (collection) {
049      SpliteratorTester.of(collection::spliterator).expect(getSampleElements());
050    }
051  }
052
053  @CollectionFeature.Require(KNOWN_ORDER)
054  public void testSpliteratorKnownOrder() {
055    synchronized (collection) {
056      SpliteratorTester.of(collection::spliterator).expect(getOrderedElements()).inOrder();
057    }
058  }
059
060  @CollectionFeature.Require(ALLOWS_NULL_VALUES)
061  @CollectionSize.Require(absent = ZERO)
062  public void testSpliteratorNullable() {
063    initCollectionWithNullElement();
064    synchronized (collection) { // for Collections.synchronized
065      assertFalse(collection.spliterator().hasCharacteristics(Spliterator.NONNULL));
066    }
067  }
068
069  @CollectionFeature.Require(SUPPORTS_ADD)
070  public void testSpliteratorNotImmutable_CollectionAllowsAdd() {
071    // If add is supported, verify that IMMUTABLE is not reported.
072    synchronized (collection) { // for Collections.synchronized
073      assertFalse(collection.spliterator().hasCharacteristics(Spliterator.IMMUTABLE));
074    }
075  }
076
077  @CollectionFeature.Require(SUPPORTS_REMOVE)
078  public void testSpliteratorNotImmutable_CollectionAllowsRemove() {
079    // If remove is supported, verify that IMMUTABLE is not reported.
080    synchronized (collection) { // for Collections.synchronized
081      assertFalse(collection.spliterator().hasCharacteristics(Spliterator.IMMUTABLE));
082    }
083  }
084
085  @GwtIncompatible // reflection
086  public static Method getSpliteratorNotImmutableCollectionAllowsAddMethod() {
087    return Helpers.getMethod(
088        CollectionSpliteratorTester.class, "testSpliteratorNotImmutable_CollectionAllowsAdd");
089  }
090
091  @GwtIncompatible // reflection
092  public static Method getSpliteratorNotImmutableCollectionAllowsRemoveMethod() {
093    return Helpers.getMethod(
094        CollectionSpliteratorTester.class, "testSpliteratorNotImmutable_CollectionAllowsRemove");
095  }
096}