11d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert/* 21d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * Copyright (C) 2008 The Guava Authors 31d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * 41d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * Licensed under the Apache License, Version 2.0 (the "License"); 51d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * you may not use this file except in compliance with the License. 61d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * You may obtain a copy of the License at 71d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * 81d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * http://www.apache.org/licenses/LICENSE-2.0 91d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * 101d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * Unless required by applicable law or agreed to in writing, software 111d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * distributed under the License is distributed on an "AS IS" BASIS, 121d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 131d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * See the License for the specific language governing permissions and 141d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * limitations under the License. 151d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert */ 161d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 171d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertpackage com.google.common.collect.testing.testers; 181d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 191d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport static com.google.common.collect.testing.features.CollectionSize.ZERO; 201d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport static com.google.common.collect.testing.features.MapFeature.ALLOWS_NULL_KEYS; 211d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport static com.google.common.collect.testing.features.MapFeature.ALLOWS_NULL_QUERIES; 221d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport static com.google.common.collect.testing.features.MapFeature.SUPPORTS_REMOVE; 231d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 241d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport com.google.common.collect.testing.AbstractMapTester; 251d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport com.google.common.collect.testing.WrongType; 261d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport com.google.common.collect.testing.features.CollectionSize; 271d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport com.google.common.collect.testing.features.MapFeature; 281d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 291d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert/** 301d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * A generic JUnit test which tests {@code remove} operations on a map. Can't be 311d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * invoked directly; please see 321d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * {@link com.google.common.collect.testing.MapTestSuiteBuilder}. 331d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * 341d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * <p>This class is GWT compatible. 351d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * 361d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * @author George van den Driessche 371d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * @author Chris Povirk 381d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert */ 391d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert@SuppressWarnings("unchecked") // too many "unchecked generic array creations" 401d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertpublic class MapRemoveTester<K, V> extends AbstractMapTester<K, V> { 411d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @MapFeature.Require(SUPPORTS_REMOVE) 421d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @CollectionSize.Require(absent = ZERO) 431d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert public void testRemove_present() { 441d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert int initialSize = getMap().size(); 451d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert assertEquals("remove(present) should return the associated value", 461d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert samples.e0.getValue(), getMap().remove(samples.e0.getKey())); 471d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert assertEquals("remove(present) should decrease a map's size by one.", 481d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert initialSize - 1, getMap().size()); 491d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert expectMissing(samples.e0); 501d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 511d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 521d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @MapFeature.Require(SUPPORTS_REMOVE) 531d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert public void testRemove_notPresent() { 541d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert assertNull("remove(notPresent) should return null", 551d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert getMap().remove(samples.e3.getKey())); 561d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert expectUnchanged(); 571d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 581d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 591d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @MapFeature.Require({SUPPORTS_REMOVE, ALLOWS_NULL_KEYS}) 601d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @CollectionSize.Require(absent = ZERO) 611d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert public void testRemove_nullPresent() { 621d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert initMapWithNullKey(); 631d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 641d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert int initialSize = getMap().size(); 651d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert assertEquals("remove(null) should return the associated value", 661d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert getValueForNullKey(), getMap().remove(null)); 671d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert assertEquals("remove(present) should decrease a map's size by one.", 681d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert initialSize - 1, getMap().size()); 691d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert expectMissing(entry(null, getValueForNullKey())); 701d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 711d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 721d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @MapFeature.Require(absent = SUPPORTS_REMOVE) 731d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @CollectionSize.Require(absent = ZERO) 741d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert public void testRemove_unsupported() { 751d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert try { 761d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert getMap().remove(samples.e0.getKey()); 771d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert fail("remove(present) should throw UnsupportedOperationException"); 781d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } catch (UnsupportedOperationException expected) { 791d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 801d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert expectUnchanged(); 811d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert assertEquals("remove(present) should not remove the element", 821d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert samples.e0.getValue(), get(samples.e0.getKey())); 831d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 841d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 851d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @MapFeature.Require(absent = SUPPORTS_REMOVE) 861d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert public void testRemove_unsupportedNotPresent() { 871d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert try { 881d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert assertNull("remove(notPresent) should return null or throw " 891d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert + "UnsupportedOperationException", 901d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert getMap().remove(samples.e3.getKey())); 911d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } catch (UnsupportedOperationException tolerated) { 921d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 931d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert expectUnchanged(); 941d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert expectMissing(samples.e3); 951d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 961d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 971d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @MapFeature.Require( 981d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert value = SUPPORTS_REMOVE, 991d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert absent = ALLOWS_NULL_QUERIES) 1001d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert public void testRemove_nullQueriesNotSupported() { 1011d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert try { 1021d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert assertNull("remove(null) should return null or throw " 1031d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert + "NullPointerException", 1041d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert getMap().remove(null)); 1051d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } catch (NullPointerException tolerated) { 1061d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 1071d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert expectUnchanged(); 1081d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 1091d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 1101d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @MapFeature.Require({SUPPORTS_REMOVE, ALLOWS_NULL_QUERIES}) 1111d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert public void testRemove_nullSupportedMissing() { 1121d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert assertNull("remove(null) should return null", getMap().remove(null)); 1131d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert expectUnchanged(); 1141d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 1151d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 1161d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @MapFeature.Require(SUPPORTS_REMOVE) 1171d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert public void testRemove_wrongType() { 1181d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert try { 1191d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert assertNull(getMap().remove(WrongType.VALUE)); 1201d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } catch (ClassCastException tolerated) { 1211d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 1221d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert expectUnchanged(); 1231d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 1241d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert} 125