001/*
002 * Copyright (C) 2007 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_QUERIES;
020import static com.google.common.collect.testing.features.CollectionFeature.ALLOWS_NULL_VALUES;
021import static com.google.common.collect.testing.features.CollectionSize.ZERO;
022
023import com.google.common.annotations.GwtCompatible;
024import com.google.common.collect.testing.AbstractCollectionTester;
025import com.google.common.collect.testing.WrongType;
026import com.google.common.collect.testing.features.CollectionFeature;
027import com.google.common.collect.testing.features.CollectionSize;
028import org.junit.Ignore;
029
030/**
031 * A generic JUnit test which tests {@code contains()} operations on a collection. Can't be invoked
032 * directly; please see {@link com.google.common.collect.testing.CollectionTestSuiteBuilder}.
033 *
034 * @author Kevin Bourrillion
035 * @author Chris Povirk
036 */
037@GwtCompatible
038@Ignore("test runners must not instantiate and run this directly, only via suites we build")
039// @Ignore affects the Android test runner, which respects JUnit 4 annotations on JUnit 3 tests.
040@SuppressWarnings("JUnit4ClassUsedInJUnit3")
041public class CollectionContainsTester<E> extends AbstractCollectionTester<E> {
042  @CollectionSize.Require(absent = ZERO)
043  public void testContains_yes() {
044    assertTrue("contains(present) should return true", collection.contains(e0()));
045  }
046
047  public void testContains_no() {
048    assertFalse("contains(notPresent) should return false", collection.contains(e3()));
049  }
050
051  @CollectionFeature.Require(ALLOWS_NULL_QUERIES)
052  public void testContains_nullNotContainedButQueriesSupported() {
053    assertFalse("contains(null) should return false", collection.contains(null));
054  }
055
056  @CollectionFeature.Require(absent = ALLOWS_NULL_QUERIES)
057  public void testContains_nullNotContainedAndUnsupported() {
058    expectNullMissingWhenNullUnsupported("contains(null) should return false or throw");
059  }
060
061  @CollectionFeature.Require(ALLOWS_NULL_VALUES)
062  @CollectionSize.Require(absent = ZERO)
063  public void testContains_nonNullWhenNullContained() {
064    initCollectionWithNullElement();
065    assertFalse("contains(notPresent) should return false", collection.contains(e3()));
066  }
067
068  @CollectionFeature.Require(ALLOWS_NULL_VALUES)
069  @CollectionSize.Require(absent = ZERO)
070  public void testContains_nullContained() {
071    initCollectionWithNullElement();
072    assertTrue("contains(null) should return true", collection.contains(null));
073  }
074
075  public void testContains_wrongType() {
076    try {
077      assertFalse(
078          "contains(wrongType) should return false or throw", collection.contains(WrongType.VALUE));
079    } catch (ClassCastException tolerated) {
080    }
081  }
082}