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;
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
037public class MapContainsKeyTester<K, V> extends AbstractMapTester<K, V> {
038  @CollectionSize.Require(absent = ZERO)
039  public void testContains_yes() {
040    assertTrue("containsKey(present) should return true", getMap().containsKey(k0()));
041  }
042
043  public void testContains_no() {
044    assertFalse("containsKey(notPresent) should return false", getMap().containsKey(k3()));
045  }
046
047  @MapFeature.Require(ALLOWS_NULL_KEY_QUERIES)
048  public void testContains_nullNotContainedButAllowed() {
049    assertFalse("containsKey(null) should return false", getMap().containsKey(null));
050  }
051
052  @MapFeature.Require(absent = ALLOWS_NULL_KEY_QUERIES)
053  public void testContains_nullNotContainedAndUnsupported() {
054    expectNullKeyMissingWhenNullKeysUnsupported("containsKey(null) should return false or throw");
055  }
056
057  @MapFeature.Require(ALLOWS_NULL_KEYS)
058  @CollectionSize.Require(absent = ZERO)
059  public void testContains_nonNullWhenNullContained() {
060    initMapWithNullKey();
061    assertFalse("containsKey(notPresent) should return false", getMap().containsKey(k3()));
062  }
063
064  @MapFeature.Require(ALLOWS_NULL_KEYS)
065  @CollectionSize.Require(absent = ZERO)
066  public void testContains_nullContained() {
067    initMapWithNullKey();
068    assertTrue("containsKey(null) should return true", getMap().containsKey(null));
069  }
070
071  @MapFeature.Require(ALLOWS_NULL_VALUES)
072  @CollectionSize.Require(absent = ZERO)
073  public void testContains_keyWithNullValueContained() {
074    initMapWithNullValue();
075    assertTrue(
076        "containsKey(keyForNullValue) should return true",
077        getMap().containsKey(getKeyForNullValue()));
078  }
079
080  public void testContains_wrongType() {
081    try {
082      // noinspection SuspiciousMethodCalls
083      assertFalse(
084          "containsKey(wrongType) should return false or throw",
085          getMap().containsKey(WrongType.VALUE));
086    } catch (ClassCastException tolerated) {
087    }
088  }
089}