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;
022import static com.google.common.collect.testing.features.MapFeature.ALLOWS_NULL_VALUES;
023
024import com.google.common.annotations.GwtCompatible;
025import com.google.common.collect.testing.AbstractMapTester;
026import com.google.common.collect.testing.WrongType;
027import com.google.common.collect.testing.features.CollectionSize;
028import com.google.common.collect.testing.features.MapFeature;
029import org.junit.Ignore;
030
031/**
032 * A generic JUnit test which tests {@code containsKey()} operations on a map. Can't be invoked
033 * directly; please see {@link com.google.common.collect.testing.MapTestSuiteBuilder}.
034 *
035 * @author George van den Driessche
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 MapContainsKeyTester<K, V> extends AbstractMapTester<K, V> {
042  @CollectionSize.Require(absent = ZERO)
043  public void testContains_yes() {
044    assertTrue("containsKey(present) should return true", getMap().containsKey(k0()));
045  }
046
047  public void testContains_no() {
048    assertFalse("containsKey(notPresent) should return false", getMap().containsKey(k3()));
049  }
050
051  @MapFeature.Require(ALLOWS_NULL_KEY_QUERIES)
052  public void testContains_nullNotContainedButAllowed() {
053    assertFalse("containsKey(null) should return false", getMap().containsKey(null));
054  }
055
056  @MapFeature.Require(absent = ALLOWS_NULL_KEY_QUERIES)
057  public void testContains_nullNotContainedAndUnsupported() {
058    expectNullKeyMissingWhenNullKeysUnsupported("containsKey(null) should return false or throw");
059  }
060
061  @MapFeature.Require(ALLOWS_NULL_KEYS)
062  @CollectionSize.Require(absent = ZERO)
063  public void testContains_nonNullWhenNullContained() {
064    initMapWithNullKey();
065    assertFalse("containsKey(notPresent) should return false", getMap().containsKey(k3()));
066  }
067
068  @MapFeature.Require(ALLOWS_NULL_KEYS)
069  @CollectionSize.Require(absent = ZERO)
070  public void testContains_nullContained() {
071    initMapWithNullKey();
072    assertTrue("containsKey(null) should return true", getMap().containsKey(null));
073  }
074
075  @MapFeature.Require(ALLOWS_NULL_VALUES)
076  @CollectionSize.Require(absent = ZERO)
077  public void testContains_keyWithNullValueContained() {
078    initMapWithNullValue();
079    assertTrue(
080        "containsKey(keyForNullValue) should return true",
081        getMap().containsKey(getKeyForNullValue()));
082  }
083
084  public void testContains_wrongType() {
085    try {
086      // noinspection SuspiciousMethodCalls
087      assertFalse(
088          "containsKey(wrongType) should return false or throw",
089          getMap().containsKey(WrongType.VALUE));
090    } catch (ClassCastException tolerated) {
091    }
092  }
093}