001/*
002 * Copyright (C) 2015 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_KEY_QUERIES;
021import static com.google.common.collect.testing.features.MapFeature.ALLOWS_NULL_VALUES;
022import static com.google.common.collect.testing.features.MapFeature.ALLOWS_NULL_VALUE_QUERIES;
023import static com.google.common.collect.testing.features.MapFeature.SUPPORTS_PUT;
024import static com.google.common.collect.testing.testers.ReflectionFreeAssertThrows.assertThrows;
025
026import com.google.common.annotations.GwtCompatible;
027import com.google.common.collect.testing.AbstractMapTester;
028import com.google.common.collect.testing.features.CollectionSize;
029import com.google.common.collect.testing.features.MapFeature;
030import java.util.concurrent.ConcurrentMap;
031import org.jspecify.annotations.NullMarked;
032import org.junit.Ignore;
033
034/**
035 * A generic JUnit test which tests {@code replace(K, V)} operations on a concurrent map. Can't be
036 * invoked directly; please see {@link
037 * com.google.common.collect.testing.ConcurrentMapTestSuiteBuilder}.
038 *
039 * @author Louis Wasserman
040 */
041@GwtCompatible
042@Ignore("test runners must not instantiate and run this directly, only via suites we build")
043// @Ignore affects the Android test runner, which respects JUnit 4 annotations on JUnit 3 tests.
044@SuppressWarnings("JUnit4ClassUsedInJUnit3")
045@NullMarked
046public class ConcurrentMapReplaceTester<K, V> extends AbstractMapTester<K, V> {
047  @Override
048  protected ConcurrentMap<K, V> getMap() {
049    return (ConcurrentMap<K, V>) super.getMap();
050  }
051
052  @MapFeature.Require(SUPPORTS_PUT)
053  @CollectionSize.Require(absent = ZERO)
054  public void testReplace_supportedPresent() {
055    assertEquals(v0(), getMap().replace(k0(), v3()));
056    expectReplacement(entry(k0(), v3()));
057  }
058
059  @MapFeature.Require(SUPPORTS_PUT)
060  @CollectionSize.Require(absent = ZERO)
061  public void testReplace_supportedPresentNoChange() {
062    assertEquals(v0(), getMap().replace(k0(), v0()));
063    expectUnchanged();
064  }
065
066  @MapFeature.Require(SUPPORTS_PUT)
067  public void testReplace_supportedAbsent() {
068    assertNull(getMap().replace(k3(), v3()));
069    expectUnchanged();
070  }
071
072  @MapFeature.Require(value = SUPPORTS_PUT, absent = ALLOWS_NULL_VALUES)
073  @CollectionSize.Require(absent = ZERO)
074  public void testReplace_presentNullValueUnsupported() {
075    assertThrows(NullPointerException.class, () -> getMap().replace(k0(), null));
076    expectUnchanged();
077  }
078
079  @MapFeature.Require(value = SUPPORTS_PUT, absent = ALLOWS_NULL_VALUE_QUERIES)
080  public void testReplace_absentNullValueUnsupported() {
081    try {
082      getMap().replace(k3(), null);
083    } catch (NullPointerException tolerated) {
084      // permitted not to throw because it would be a no-op
085    }
086    expectUnchanged();
087  }
088
089  @MapFeature.Require(value = SUPPORTS_PUT, absent = ALLOWS_NULL_KEY_QUERIES)
090  public void testReplace_absentNullKeyUnsupported() {
091    try {
092      getMap().replace(null, v3());
093    } catch (NullPointerException tolerated) {
094      // permitted not to throw because it would be a no-op
095    }
096    expectUnchanged();
097  }
098
099  @MapFeature.Require(absent = SUPPORTS_PUT)
100  @CollectionSize.Require(absent = ZERO)
101  public void testReplace_unsupportedPresent() {
102    assertThrows(UnsupportedOperationException.class, () -> getMap().replace(k0(), v3()));
103    expectUnchanged();
104  }
105}