001/*
002 * Copyright (C) 2008 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.CollectionSize.ZERO;
020import static com.google.common.collect.testing.features.MapFeature.ALLOWS_NULL_KEYS;
021import static com.google.common.collect.testing.features.MapFeature.ALLOWS_NULL_KEY_QUERIES;
022
023import com.google.common.annotations.GwtCompatible;
024import com.google.common.collect.testing.AbstractMapTester;
025import com.google.common.collect.testing.WrongType;
026import com.google.common.collect.testing.features.CollectionSize;
027import com.google.common.collect.testing.features.MapFeature;
028import org.junit.Ignore;
029
030/**
031 * A generic JUnit test which tests {@code containsKey()} operations on a map. Can't be invoked
032 * directly; please see {@link com.google.common.collect.testing.MapTestSuiteBuilder}.
033 *
034 * @author George van den Driessche
035 */
036@GwtCompatible
037@Ignore("test runners must not instantiate and run this directly, only via suites we build")
038// @Ignore affects the Android test runner, which respects JUnit 4 annotations on JUnit 3 tests.
039@SuppressWarnings("JUnit4ClassUsedInJUnit3")
040public class MapContainsKeyTester<K, V> extends AbstractMapTester<K, V> {
041  @CollectionSize.Require(absent = ZERO)
042  public void testContains_yes() {
043    assertTrue("containsKey(present) should return true", getMap().containsKey(k0()));
044  }
045
046  public void testContains_no() {
047    assertFalse("containsKey(notPresent) should return false", getMap().containsKey(k3()));
048  }
049
050  @MapFeature.Require(ALLOWS_NULL_KEY_QUERIES)
051  public void testContains_nullNotContainedButAllowed() {
052    assertFalse("containsKey(null) should return false", getMap().containsKey(null));
053  }
054
055  @MapFeature.Require(absent = ALLOWS_NULL_KEY_QUERIES)
056  public void testContains_nullNotContainedAndUnsupported() {
057    expectNullKeyMissingWhenNullKeysUnsupported("containsKey(null) should return false or throw");
058  }
059
060  @MapFeature.Require(ALLOWS_NULL_KEYS)
061  @CollectionSize.Require(absent = ZERO)
062  public void testContains_nonNullWhenNullContained() {
063    initMapWithNullKey();
064    assertFalse("containsKey(notPresent) should return false", getMap().containsKey(k3()));
065  }
066
067  @MapFeature.Require(ALLOWS_NULL_KEYS)
068  @CollectionSize.Require(absent = ZERO)
069  public void testContains_nullContained() {
070    initMapWithNullKey();
071    assertTrue("containsKey(null) should return true", getMap().containsKey(null));
072  }
073
074  public void testContains_wrongType() {
075    try {
076      // noinspection SuspiciousMethodCalls
077      assertFalse(
078          "containsKey(wrongType) should return false or throw",
079          getMap().containsKey(WrongType.VALUE));
080    } catch (ClassCastException tolerated) {
081    }
082  }
083}