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.Helpers.getMethod;
020import static com.google.common.collect.testing.features.CollectionFeature.ALLOWS_NULL_VALUES;
021import static com.google.common.collect.testing.features.CollectionFeature.KNOWN_ORDER;
022import static com.google.common.collect.testing.features.CollectionFeature.SUPPORTS_ADD;
023import static com.google.common.collect.testing.features.CollectionFeature.SUPPORTS_REMOVE;
024import static com.google.common.collect.testing.features.CollectionSize.ZERO;
025
026import com.google.common.annotations.GwtCompatible;
027import com.google.common.annotations.GwtIncompatible;
028import com.google.common.annotations.J2ktIncompatible;
029import com.google.common.collect.testing.AbstractCollectionTester;
030import com.google.common.collect.testing.SpliteratorTester;
031import com.google.common.collect.testing.features.CollectionFeature;
032import com.google.common.collect.testing.features.CollectionSize;
033import java.lang.reflect.Method;
034import java.util.Spliterator;
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
043public class CollectionSpliteratorTester<E> extends AbstractCollectionTester<E> {
044
045  @CollectionFeature.Require(absent = KNOWN_ORDER)
046  public void testSpliteratorUnknownOrder() {
047    SpliteratorTester.of(collection::spliterator).expect(getSampleElements());
048  }
049
050  @CollectionFeature.Require(KNOWN_ORDER)
051  public void testSpliteratorKnownOrder() {
052    SpliteratorTester.of(collection::spliterator).expect(getOrderedElements()).inOrder();
053  }
054
055  @CollectionFeature.Require(ALLOWS_NULL_VALUES)
056  @CollectionSize.Require(absent = ZERO)
057  public void testSpliteratorNullable() {
058    initCollectionWithNullElement();
059    assertFalse(collection.spliterator().hasCharacteristics(Spliterator.NONNULL));
060  }
061
062  @CollectionFeature.Require(SUPPORTS_ADD)
063  public void testSpliteratorNotImmutable_collectionAllowsAdd() {
064    // If add is supported, verify that IMMUTABLE is not reported.
065    assertFalse(collection.spliterator().hasCharacteristics(Spliterator.IMMUTABLE));
066  }
067
068  @CollectionFeature.Require(SUPPORTS_REMOVE)
069  public void testSpliteratorNotImmutable_collectionAllowsRemove() {
070    // If remove is supported, verify that IMMUTABLE is not reported.
071    assertFalse(collection.spliterator().hasCharacteristics(Spliterator.IMMUTABLE));
072  }
073
074  @J2ktIncompatible
075  @GwtIncompatible // reflection
076  public static Method getSpliteratorNotImmutableCollectionAllowsAddMethod() {
077    return getMethod(
078        CollectionSpliteratorTester.class, "testSpliteratorNotImmutable_collectionAllowsAdd");
079  }
080
081  @J2ktIncompatible
082  @GwtIncompatible // reflection
083  public static Method getSpliteratorNotImmutableCollectionAllowsRemoveMethod() {
084    return getMethod(
085        CollectionSpliteratorTester.class, "testSpliteratorNotImmutable_collectionAllowsRemove");
086  }
087}