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;
028
029/**
030 * A generic JUnit test which tests {@code containsKey()} operations on a map. Can't be invoked
031 * directly; please see {@link com.google.common.collect.testing.MapTestSuiteBuilder}.
032 *
033 * @author George van den Driessche
034 */
035@GwtCompatible
036public class MapContainsKeyTester<K, V> extends AbstractMapTester<K, V> {
037  @CollectionSize.Require(absent = ZERO)
038  public void testContains_yes() {
039    assertTrue("containsKey(present) should return true", getMap().containsKey(k0()));
040  }
041
042  public void testContains_no() {
043    assertFalse("containsKey(notPresent) should return false", getMap().containsKey(k3()));
044  }
045
046  @MapFeature.Require(ALLOWS_NULL_KEY_QUERIES)
047  public void testContains_nullNotContainedButAllowed() {
048    assertFalse("containsKey(null) should return false", getMap().containsKey(null));
049  }
050
051  @MapFeature.Require(absent = ALLOWS_NULL_KEY_QUERIES)
052  public void testContains_nullNotContainedAndUnsupported() {
053    expectNullKeyMissingWhenNullKeysUnsupported("containsKey(null) should return false or throw");
054  }
055
056  @MapFeature.Require(ALLOWS_NULL_KEYS)
057  @CollectionSize.Require(absent = ZERO)
058  public void testContains_nonNullWhenNullContained() {
059    initMapWithNullKey();
060    assertFalse("containsKey(notPresent) should return false", getMap().containsKey(k3()));
061  }
062
063  @MapFeature.Require(ALLOWS_NULL_KEYS)
064  @CollectionSize.Require(absent = ZERO)
065  public void testContains_nullContained() {
066    initMapWithNullKey();
067    assertTrue("containsKey(null) should return true", getMap().containsKey(null));
068  }
069
070  public void testContains_wrongType() {
071    try {
072      // noinspection SuspiciousMethodCalls
073      assertFalse(
074          "containsKey(wrongType) should return false or throw",
075          getMap().containsKey(WrongType.VALUE));
076    } catch (ClassCastException tolerated) {
077    }
078  }
079}