| /* |
| * Copyright (C) 2008 The Guava Authors |
| * |
| * Licensed under the Apache License, Version 2.0 (the "License"); |
| * you may not use this file except in compliance with the License. |
| * You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| |
| package com.google.common.collect; |
| |
| import static com.google.common.collect.testing.Helpers.mapEntry; |
| import static com.google.common.testing.SerializableTester.reserialize; |
| import static com.google.common.truth.Truth.assertThat; |
| |
| import com.google.common.annotations.GwtCompatible; |
| import com.google.common.annotations.GwtIncompatible; |
| import com.google.common.base.Equivalence; |
| import com.google.common.base.Joiner; |
| import com.google.common.collect.ImmutableMap.Builder; |
| import com.google.common.collect.testing.AnEnum; |
| import com.google.common.collect.testing.CollectionTestSuiteBuilder; |
| import com.google.common.collect.testing.ListTestSuiteBuilder; |
| import com.google.common.collect.testing.MapInterfaceTest; |
| import com.google.common.collect.testing.MapTestSuiteBuilder; |
| import com.google.common.collect.testing.MinimalSet; |
| import com.google.common.collect.testing.SampleElements.Colliders; |
| import com.google.common.collect.testing.SampleElements.Unhashables; |
| import com.google.common.collect.testing.TestStringMapGenerator; |
| import com.google.common.collect.testing.UnhashableObject; |
| import com.google.common.collect.testing.features.CollectionFeature; |
| import com.google.common.collect.testing.features.CollectionSize; |
| import com.google.common.collect.testing.features.MapFeature; |
| import com.google.common.collect.testing.google.MapGenerators.ImmutableMapCopyOfEntriesGenerator; |
| import com.google.common.collect.testing.google.MapGenerators.ImmutableMapCopyOfEnumMapGenerator; |
| import com.google.common.collect.testing.google.MapGenerators.ImmutableMapCopyOfGenerator; |
| import com.google.common.collect.testing.google.MapGenerators.ImmutableMapEntryListGenerator; |
| import com.google.common.collect.testing.google.MapGenerators.ImmutableMapGenerator; |
| import com.google.common.collect.testing.google.MapGenerators.ImmutableMapKeyListGenerator; |
| import com.google.common.collect.testing.google.MapGenerators.ImmutableMapUnhashableValuesGenerator; |
| import com.google.common.collect.testing.google.MapGenerators.ImmutableMapValueListGenerator; |
| import com.google.common.collect.testing.google.MapGenerators.ImmutableMapValuesAsSingletonSetGenerator; |
| import com.google.common.testing.CollectorTester; |
| import com.google.common.testing.EqualsTester; |
| import com.google.common.testing.NullPointerTester; |
| import com.google.common.testing.SerializableTester; |
| import com.google.errorprone.annotations.CanIgnoreReturnValue; |
| import java.io.Serializable; |
| import java.util.AbstractMap; |
| import java.util.Arrays; |
| import java.util.Collection; |
| import java.util.Collections; |
| import java.util.EnumMap; |
| import java.util.LinkedHashMap; |
| import java.util.List; |
| import java.util.Map; |
| import java.util.Map.Entry; |
| import java.util.stream.Collector; |
| import java.util.stream.Stream; |
| import junit.framework.Test; |
| import junit.framework.TestCase; |
| import junit.framework.TestSuite; |
| import org.checkerframework.checker.nullness.qual.Nullable; |
| |
| /** |
| * Tests for {@link ImmutableMap}. |
| * |
| * @author Kevin Bourrillion |
| * @author Jesse Wilson |
| */ |
| @GwtCompatible(emulated = true) |
| public class ImmutableMapTest extends TestCase { |
| |
| @GwtIncompatible // suite |
| public static Test suite() { |
| TestSuite suite = new TestSuite(); |
| suite.addTestSuite(ImmutableMapTest.class); |
| |
| suite.addTest( |
| MapTestSuiteBuilder.using(new ImmutableMapGenerator()) |
| .withFeatures( |
| CollectionSize.ANY, |
| CollectionFeature.SERIALIZABLE_INCLUDING_VIEWS, |
| CollectionFeature.KNOWN_ORDER, |
| MapFeature.REJECTS_DUPLICATES_AT_CREATION, |
| CollectionFeature.ALLOWS_NULL_QUERIES) |
| .named("ImmutableMap") |
| .createTestSuite()); |
| |
| suite.addTest( |
| MapTestSuiteBuilder.using( |
| new TestStringMapGenerator() { |
| @Override |
| protected Map<String, String> create(Entry<String, String>[] entries) { |
| ImmutableMap.Builder<String, String> builder = ImmutableMap.builder(); |
| builder.putAll(Arrays.asList(entries)); |
| return builder.buildJdkBacked(); |
| } |
| }) |
| .withFeatures( |
| CollectionSize.ANY, |
| CollectionFeature.SERIALIZABLE_INCLUDING_VIEWS, |
| CollectionFeature.KNOWN_ORDER, |
| MapFeature.REJECTS_DUPLICATES_AT_CREATION, |
| CollectionFeature.ALLOWS_NULL_QUERIES) |
| .named("ImmutableMap [JDK backed]") |
| .createTestSuite()); |
| |
| suite.addTest( |
| MapTestSuiteBuilder.using(new ImmutableMapCopyOfGenerator()) |
| .withFeatures( |
| CollectionSize.ANY, |
| CollectionFeature.SERIALIZABLE_INCLUDING_VIEWS, |
| CollectionFeature.KNOWN_ORDER, |
| CollectionFeature.ALLOWS_NULL_QUERIES) |
| .named("ImmutableMap.copyOf[Map]") |
| .createTestSuite()); |
| |
| suite.addTest( |
| MapTestSuiteBuilder.using(new ImmutableMapCopyOfEntriesGenerator()) |
| .withFeatures( |
| CollectionSize.ANY, |
| MapFeature.REJECTS_DUPLICATES_AT_CREATION, |
| CollectionFeature.SERIALIZABLE_INCLUDING_VIEWS, |
| CollectionFeature.KNOWN_ORDER, |
| CollectionFeature.ALLOWS_NULL_QUERIES) |
| .named("ImmutableMap.copyOf[Iterable<Entry>]") |
| .createTestSuite()); |
| |
| suite.addTest( |
| MapTestSuiteBuilder.using(new ImmutableMapCopyOfEnumMapGenerator()) |
| .withFeatures( |
| CollectionSize.ANY, |
| CollectionFeature.SERIALIZABLE_INCLUDING_VIEWS, |
| CollectionFeature.KNOWN_ORDER, |
| CollectionFeature.ALLOWS_NULL_QUERIES) |
| .named("ImmutableMap.copyOf[EnumMap]") |
| .createTestSuite()); |
| |
| suite.addTest( |
| MapTestSuiteBuilder.using(new ImmutableMapValuesAsSingletonSetGenerator()) |
| .withFeatures( |
| CollectionSize.ANY, |
| MapFeature.REJECTS_DUPLICATES_AT_CREATION, |
| CollectionFeature.KNOWN_ORDER, |
| CollectionFeature.ALLOWS_NULL_QUERIES) |
| .named("ImmutableMap.asMultimap.asMap") |
| .createTestSuite()); |
| |
| suite.addTest( |
| CollectionTestSuiteBuilder.using(new ImmutableMapUnhashableValuesGenerator()) |
| .withFeatures( |
| CollectionSize.ANY, |
| CollectionFeature.KNOWN_ORDER, |
| CollectionFeature.ALLOWS_NULL_QUERIES) |
| .named("ImmutableMap.values, unhashable") |
| .createTestSuite()); |
| |
| suite.addTest( |
| ListTestSuiteBuilder.using(new ImmutableMapKeyListGenerator()) |
| .named("ImmutableMap.keySet.asList") |
| .withFeatures( |
| CollectionSize.ANY, |
| CollectionFeature.SERIALIZABLE, |
| CollectionFeature.REJECTS_DUPLICATES_AT_CREATION, |
| CollectionFeature.ALLOWS_NULL_QUERIES) |
| .createTestSuite()); |
| |
| suite.addTest( |
| ListTestSuiteBuilder.using(new ImmutableMapEntryListGenerator()) |
| .named("ImmutableMap.entrySet.asList") |
| .withFeatures( |
| CollectionSize.ANY, |
| CollectionFeature.SERIALIZABLE, |
| CollectionFeature.REJECTS_DUPLICATES_AT_CREATION, |
| CollectionFeature.ALLOWS_NULL_QUERIES) |
| .createTestSuite()); |
| |
| suite.addTest( |
| ListTestSuiteBuilder.using(new ImmutableMapValueListGenerator()) |
| .named("ImmutableMap.values.asList") |
| .withFeatures( |
| CollectionSize.ANY, |
| CollectionFeature.SERIALIZABLE, |
| CollectionFeature.ALLOWS_NULL_QUERIES) |
| .createTestSuite()); |
| |
| return suite; |
| } |
| |
| public abstract static class AbstractMapTests<K, V> extends MapInterfaceTest<K, V> { |
| public AbstractMapTests() { |
| super(false, false, false, false, false); |
| } |
| |
| @Override |
| protected Map<K, V> makeEmptyMap() { |
| throw new UnsupportedOperationException(); |
| } |
| |
| private static final Joiner joiner = Joiner.on(", "); |
| |
| @Override |
| protected void assertMoreInvariants(Map<K, V> map) { |
| // TODO: can these be moved to MapInterfaceTest? |
| for (Entry<K, V> entry : map.entrySet()) { |
| assertEquals(entry.getKey() + "=" + entry.getValue(), entry.toString()); |
| } |
| |
| assertEquals("{" + joiner.join(map.entrySet()) + "}", map.toString()); |
| assertEquals("[" + joiner.join(map.entrySet()) + "]", map.entrySet().toString()); |
| assertEquals("[" + joiner.join(map.keySet()) + "]", map.keySet().toString()); |
| assertEquals("[" + joiner.join(map.values()) + "]", map.values().toString()); |
| |
| assertEquals(MinimalSet.from(map.entrySet()), map.entrySet()); |
| assertEquals(Sets.newHashSet(map.keySet()), map.keySet()); |
| } |
| } |
| |
| public static class MapTests extends AbstractMapTests<String, Integer> { |
| @Override |
| protected Map<String, Integer> makeEmptyMap() { |
| return ImmutableMap.of(); |
| } |
| |
| @Override |
| protected Map<String, Integer> makePopulatedMap() { |
| return ImmutableMap.of("one", 1, "two", 2, "three", 3); |
| } |
| |
| @Override |
| protected String getKeyNotInPopulatedMap() { |
| return "minus one"; |
| } |
| |
| @Override |
| protected Integer getValueNotInPopulatedMap() { |
| return -1; |
| } |
| } |
| |
| public static class SingletonMapTests extends AbstractMapTests<String, Integer> { |
| @Override |
| protected Map<String, Integer> makePopulatedMap() { |
| return ImmutableMap.of("one", 1); |
| } |
| |
| @Override |
| protected String getKeyNotInPopulatedMap() { |
| return "minus one"; |
| } |
| |
| @Override |
| protected Integer getValueNotInPopulatedMap() { |
| return -1; |
| } |
| } |
| |
| @GwtIncompatible // SerializableTester |
| public static class ReserializedMapTests extends AbstractMapTests<String, Integer> { |
| @Override |
| protected Map<String, Integer> makePopulatedMap() { |
| return SerializableTester.reserialize(ImmutableMap.of("one", 1, "two", 2, "three", 3)); |
| } |
| |
| @Override |
| protected String getKeyNotInPopulatedMap() { |
| return "minus one"; |
| } |
| |
| @Override |
| protected Integer getValueNotInPopulatedMap() { |
| return -1; |
| } |
| } |
| |
| public static class MapTestsWithBadHashes extends AbstractMapTests<Object, Integer> { |
| |
| @Override |
| protected Map<Object, Integer> makeEmptyMap() { |
| throw new UnsupportedOperationException(); |
| } |
| |
| @Override |
| protected Map<Object, Integer> makePopulatedMap() { |
| Colliders colliders = new Colliders(); |
| return ImmutableMap.of( |
| colliders.e0(), 0, |
| colliders.e1(), 1, |
| colliders.e2(), 2, |
| colliders.e3(), 3); |
| } |
| |
| @Override |
| protected Object getKeyNotInPopulatedMap() { |
| return new Colliders().e4(); |
| } |
| |
| @Override |
| protected Integer getValueNotInPopulatedMap() { |
| return 4; |
| } |
| } |
| |
| @GwtIncompatible // GWT's ImmutableMap emulation is backed by java.util.HashMap. |
| public static class MapTestsWithUnhashableValues |
| extends AbstractMapTests<Integer, UnhashableObject> { |
| @Override |
| protected Map<Integer, UnhashableObject> makeEmptyMap() { |
| return ImmutableMap.of(); |
| } |
| |
| @Override |
| protected Map<Integer, UnhashableObject> makePopulatedMap() { |
| Unhashables unhashables = new Unhashables(); |
| return ImmutableMap.of(0, unhashables.e0(), 1, unhashables.e1(), 2, unhashables.e2()); |
| } |
| |
| @Override |
| protected Integer getKeyNotInPopulatedMap() { |
| return 3; |
| } |
| |
| @Override |
| protected UnhashableObject getValueNotInPopulatedMap() { |
| return new Unhashables().e3(); |
| } |
| } |
| |
| @GwtIncompatible // GWT's ImmutableMap emulation is backed by java.util.HashMap. |
| public static class MapTestsWithSingletonUnhashableValue extends MapTestsWithUnhashableValues { |
| @Override |
| protected Map<Integer, UnhashableObject> makePopulatedMap() { |
| Unhashables unhashables = new Unhashables(); |
| return ImmutableMap.of(0, unhashables.e0()); |
| } |
| } |
| |
| public static class CreationTests extends TestCase { |
| public void testEmptyBuilder() { |
| ImmutableMap<String, Integer> map = new Builder<String, Integer>().build(); |
| assertEquals(Collections.<String, Integer>emptyMap(), map); |
| } |
| |
| public void testSingletonBuilder() { |
| ImmutableMap<String, Integer> map = new Builder<String, Integer>().put("one", 1).build(); |
| assertMapEquals(map, "one", 1); |
| } |
| |
| public void testBuilder() { |
| ImmutableMap<String, Integer> map = |
| new Builder<String, Integer>() |
| .put("one", 1) |
| .put("two", 2) |
| .put("three", 3) |
| .put("four", 4) |
| .put("five", 5) |
| .build(); |
| assertMapEquals(map, "one", 1, "two", 2, "three", 3, "four", 4, "five", 5); |
| } |
| |
| @GwtIncompatible |
| public void testBuilderExactlySizedReusesArray() { |
| ImmutableMap.Builder<Integer, Integer> builder = ImmutableMap.builderWithExpectedSize(10); |
| Entry<Integer, Integer>[] builderArray = builder.entries; |
| for (int i = 0; i < 10; i++) { |
| builder.put(i, i); |
| } |
| Entry<Integer, Integer>[] builderArrayAfterPuts = builder.entries; |
| RegularImmutableMap<Integer, Integer> map = |
| (RegularImmutableMap<Integer, Integer>) builder.build(); |
| Entry<Integer, Integer>[] mapInternalArray = map.entries; |
| assertSame(builderArray, builderArrayAfterPuts); |
| assertSame(builderArray, mapInternalArray); |
| } |
| |
| public void testBuilder_orderEntriesByValue() { |
| ImmutableMap<String, Integer> map = |
| new Builder<String, Integer>() |
| .orderEntriesByValue(Ordering.natural()) |
| .put("three", 3) |
| .put("one", 1) |
| .put("five", 5) |
| .put("four", 4) |
| .put("two", 2) |
| .build(); |
| assertMapEquals(map, "one", 1, "two", 2, "three", 3, "four", 4, "five", 5); |
| } |
| |
| public void testBuilder_orderEntriesByValueAfterExactSizeBuild() { |
| Builder<String, Integer> builder = |
| new Builder<String, Integer>(2).put("four", 4).put("one", 1); |
| ImmutableMap<String, Integer> keyOrdered = builder.build(); |
| ImmutableMap<String, Integer> valueOrdered = |
| builder.orderEntriesByValue(Ordering.natural()).build(); |
| assertMapEquals(keyOrdered, "four", 4, "one", 1); |
| assertMapEquals(valueOrdered, "one", 1, "four", 4); |
| } |
| |
| public void testBuilder_orderEntriesByValue_usedTwiceFails() { |
| ImmutableMap.Builder<String, Integer> builder = |
| new Builder<String, Integer>().orderEntriesByValue(Ordering.natural()); |
| try { |
| builder.orderEntriesByValue(Ordering.natural()); |
| fail("Expected IllegalStateException"); |
| } catch (IllegalStateException expected) { |
| } |
| } |
| |
| public void testBuilder_withImmutableEntry() { |
| ImmutableMap<String, Integer> map = |
| new Builder<String, Integer>().put(Maps.immutableEntry("one", 1)).build(); |
| assertMapEquals(map, "one", 1); |
| } |
| |
| public void testBuilder_withImmutableEntryAndNullContents() { |
| Builder<String, Integer> builder = new Builder<>(); |
| try { |
| builder.put(Maps.immutableEntry("one", (Integer) null)); |
| fail(); |
| } catch (NullPointerException expected) { |
| } |
| try { |
| builder.put(Maps.immutableEntry((String) null, 1)); |
| fail(); |
| } catch (NullPointerException expected) { |
| } |
| } |
| |
| private static class StringHolder { |
| String string; |
| } |
| |
| public void testBuilder_withMutableEntry() { |
| ImmutableMap.Builder<String, Integer> builder = new Builder<>(); |
| final StringHolder holder = new StringHolder(); |
| holder.string = "one"; |
| Entry<String, Integer> entry = |
| new AbstractMapEntry<String, Integer>() { |
| @Override |
| public String getKey() { |
| return holder.string; |
| } |
| |
| @Override |
| public Integer getValue() { |
| return 1; |
| } |
| }; |
| |
| builder.put(entry); |
| holder.string = "two"; |
| assertMapEquals(builder.build(), "one", 1); |
| } |
| |
| public void testBuilderPutAllWithEmptyMap() { |
| ImmutableMap<String, Integer> map = |
| new Builder<String, Integer>().putAll(Collections.<String, Integer>emptyMap()).build(); |
| assertEquals(Collections.<String, Integer>emptyMap(), map); |
| } |
| |
| public void testBuilderPutAll() { |
| Map<String, Integer> toPut = new LinkedHashMap<>(); |
| toPut.put("one", 1); |
| toPut.put("two", 2); |
| toPut.put("three", 3); |
| Map<String, Integer> moreToPut = new LinkedHashMap<>(); |
| moreToPut.put("four", 4); |
| moreToPut.put("five", 5); |
| |
| ImmutableMap<String, Integer> map = |
| new Builder<String, Integer>().putAll(toPut).putAll(moreToPut).build(); |
| assertMapEquals(map, "one", 1, "two", 2, "three", 3, "four", 4, "five", 5); |
| } |
| |
| public void testBuilderReuse() { |
| Builder<String, Integer> builder = new Builder<>(); |
| ImmutableMap<String, Integer> mapOne = builder.put("one", 1).put("two", 2).build(); |
| ImmutableMap<String, Integer> mapTwo = builder.put("three", 3).put("four", 4).build(); |
| |
| assertMapEquals(mapOne, "one", 1, "two", 2); |
| assertMapEquals(mapTwo, "one", 1, "two", 2, "three", 3, "four", 4); |
| } |
| |
| public void testBuilderPutNullKeyFailsAtomically() { |
| Builder<String, Integer> builder = new Builder<>(); |
| try { |
| builder.put(null, 1); |
| fail(); |
| } catch (NullPointerException expected) { |
| } |
| builder.put("foo", 2); |
| assertMapEquals(builder.build(), "foo", 2); |
| } |
| |
| public void testBuilderPutImmutableEntryWithNullKeyFailsAtomically() { |
| Builder<String, Integer> builder = new Builder<>(); |
| try { |
| builder.put(Maps.immutableEntry((String) null, 1)); |
| fail(); |
| } catch (NullPointerException expected) { |
| } |
| builder.put("foo", 2); |
| assertMapEquals(builder.build(), "foo", 2); |
| } |
| |
| // for GWT compatibility |
| static class SimpleEntry<K, V> extends AbstractMapEntry<K, V> { |
| public K key; |
| public V value; |
| |
| SimpleEntry(K key, V value) { |
| this.key = key; |
| this.value = value; |
| } |
| |
| @Override |
| public K getKey() { |
| return key; |
| } |
| |
| @Override |
| public V getValue() { |
| return value; |
| } |
| } |
| |
| public void testBuilderPutMutableEntryWithNullKeyFailsAtomically() { |
| Builder<String, Integer> builder = new Builder<>(); |
| try { |
| builder.put(new SimpleEntry<String, Integer>(null, 1)); |
| fail(); |
| } catch (NullPointerException expected) { |
| } |
| builder.put("foo", 2); |
| assertMapEquals(builder.build(), "foo", 2); |
| } |
| |
| public void testBuilderPutNullKey() { |
| Builder<String, Integer> builder = new Builder<>(); |
| try { |
| builder.put(null, 1); |
| fail(); |
| } catch (NullPointerException expected) { |
| } |
| } |
| |
| public void testBuilderPutNullValue() { |
| Builder<String, Integer> builder = new Builder<>(); |
| try { |
| builder.put("one", null); |
| fail(); |
| } catch (NullPointerException expected) { |
| } |
| } |
| |
| public void testBuilderPutNullKeyViaPutAll() { |
| Builder<String, Integer> builder = new Builder<>(); |
| try { |
| builder.putAll(Collections.<String, Integer>singletonMap(null, 1)); |
| fail(); |
| } catch (NullPointerException expected) { |
| } |
| } |
| |
| public void testBuilderPutNullValueViaPutAll() { |
| Builder<String, Integer> builder = new Builder<>(); |
| try { |
| builder.putAll(Collections.<String, Integer>singletonMap("one", null)); |
| fail(); |
| } catch (NullPointerException expected) { |
| } |
| } |
| |
| public void testPuttingTheSameKeyTwiceThrowsOnBuild() { |
| Builder<String, Integer> builder = |
| new Builder<String, Integer>() |
| .put("one", 1) |
| .put("one", 1); // throwing on this line would be even better |
| |
| try { |
| builder.build(); |
| fail(); |
| } catch (IllegalArgumentException expected) { |
| } |
| } |
| |
| public void testOf() { |
| assertMapEquals(ImmutableMap.of("one", 1), "one", 1); |
| assertMapEquals(ImmutableMap.of("one", 1, "two", 2), "one", 1, "two", 2); |
| assertMapEquals( |
| ImmutableMap.of("one", 1, "two", 2, "three", 3), "one", 1, "two", 2, "three", 3); |
| assertMapEquals( |
| ImmutableMap.of("one", 1, "two", 2, "three", 3, "four", 4), |
| "one", |
| 1, |
| "two", |
| 2, |
| "three", |
| 3, |
| "four", |
| 4); |
| assertMapEquals( |
| ImmutableMap.of("one", 1, "two", 2, "three", 3, "four", 4, "five", 5), |
| "one", |
| 1, |
| "two", |
| 2, |
| "three", |
| 3, |
| "four", |
| 4, |
| "five", |
| 5); |
| } |
| |
| public void testOfNullKey() { |
| try { |
| ImmutableMap.of(null, 1); |
| fail(); |
| } catch (NullPointerException expected) { |
| } |
| |
| try { |
| ImmutableMap.of("one", 1, null, 2); |
| fail(); |
| } catch (NullPointerException expected) { |
| } |
| } |
| |
| public void testOfNullValue() { |
| try { |
| ImmutableMap.of("one", null); |
| fail(); |
| } catch (NullPointerException expected) { |
| } |
| |
| try { |
| ImmutableMap.of("one", 1, "two", null); |
| fail(); |
| } catch (NullPointerException expected) { |
| } |
| } |
| |
| public void testOfWithDuplicateKey() { |
| try { |
| ImmutableMap.of("one", 1, "one", 1); |
| fail(); |
| } catch (IllegalArgumentException expected) { |
| } |
| } |
| |
| public void testCopyOfEmptyMap() { |
| ImmutableMap<String, Integer> copy = |
| ImmutableMap.copyOf(Collections.<String, Integer>emptyMap()); |
| assertEquals(Collections.<String, Integer>emptyMap(), copy); |
| assertSame(copy, ImmutableMap.copyOf(copy)); |
| } |
| |
| public void testCopyOfSingletonMap() { |
| ImmutableMap<String, Integer> copy = ImmutableMap.copyOf(Collections.singletonMap("one", 1)); |
| assertMapEquals(copy, "one", 1); |
| assertSame(copy, ImmutableMap.copyOf(copy)); |
| } |
| |
| public void testCopyOf() { |
| Map<String, Integer> original = new LinkedHashMap<>(); |
| original.put("one", 1); |
| original.put("two", 2); |
| original.put("three", 3); |
| |
| ImmutableMap<String, Integer> copy = ImmutableMap.copyOf(original); |
| assertMapEquals(copy, "one", 1, "two", 2, "three", 3); |
| assertSame(copy, ImmutableMap.copyOf(copy)); |
| } |
| |
| public void testToImmutableMap() { |
| Collector<Entry<String, Integer>, ?, ImmutableMap<String, Integer>> collector = |
| ImmutableMap.toImmutableMap(Entry::getKey, Entry::getValue); |
| Equivalence<ImmutableMap<String, Integer>> equivalence = |
| Equivalence.equals() |
| .<Entry<String, Integer>>pairwise() |
| .onResultOf(ImmutableMap::entrySet); |
| CollectorTester.of(collector, equivalence) |
| .expectCollects( |
| ImmutableMap.of("one", 1, "two", 2, "three", 3), |
| mapEntry("one", 1), |
| mapEntry("two", 2), |
| mapEntry("three", 3)); |
| } |
| |
| public void testToImmutableMap_exceptionOnDuplicateKey() { |
| Collector<Entry<String, Integer>, ?, ImmutableMap<String, Integer>> collector = |
| ImmutableMap.toImmutableMap(Entry::getKey, Entry::getValue); |
| try { |
| Stream.of(mapEntry("one", 1), mapEntry("one", 11)).collect(collector); |
| fail("Expected IllegalArgumentException"); |
| } catch (IllegalArgumentException expected) { |
| } |
| } |
| |
| public void testToImmutableMapMerging() { |
| Collector<Entry<String, Integer>, ?, ImmutableMap<String, Integer>> collector = |
| ImmutableMap.toImmutableMap(Entry::getKey, Entry::getValue, Integer::sum); |
| Equivalence<ImmutableMap<String, Integer>> equivalence = |
| Equivalence.equals() |
| .<Entry<String, Integer>>pairwise() |
| .onResultOf(ImmutableMap::entrySet); |
| CollectorTester.of(collector, equivalence) |
| .expectCollects( |
| ImmutableMap.of("one", 1, "two", 4, "three", 3), |
| mapEntry("one", 1), |
| mapEntry("two", 2), |
| mapEntry("three", 3), |
| mapEntry("two", 2)); |
| } |
| } |
| |
| public void testNullGet() { |
| ImmutableMap<String, Integer> map = ImmutableMap.of("one", 1); |
| assertNull(map.get(null)); |
| } |
| |
| public void testAsMultimap() { |
| ImmutableMap<String, Integer> map = |
| ImmutableMap.of("one", 1, "won", 1, "two", 2, "too", 2, "three", 3); |
| ImmutableSetMultimap<String, Integer> expected = |
| ImmutableSetMultimap.of("one", 1, "won", 1, "two", 2, "too", 2, "three", 3); |
| assertEquals(expected, map.asMultimap()); |
| } |
| |
| public void testAsMultimapWhenEmpty() { |
| ImmutableMap<String, Integer> map = ImmutableMap.of(); |
| ImmutableSetMultimap<String, Integer> expected = ImmutableSetMultimap.of(); |
| assertEquals(expected, map.asMultimap()); |
| } |
| |
| public void testAsMultimapCaches() { |
| ImmutableMap<String, Integer> map = ImmutableMap.of("one", 1); |
| ImmutableSetMultimap<String, Integer> multimap1 = map.asMultimap(); |
| ImmutableSetMultimap<String, Integer> multimap2 = map.asMultimap(); |
| assertEquals(1, multimap1.asMap().size()); |
| assertSame(multimap1, multimap2); |
| } |
| |
| @GwtIncompatible // NullPointerTester |
| public void testNullPointers() { |
| NullPointerTester tester = new NullPointerTester(); |
| tester.testAllPublicStaticMethods(ImmutableMap.class); |
| tester.testAllPublicInstanceMethods(new ImmutableMap.Builder<Object, Object>()); |
| tester.testAllPublicInstanceMethods(ImmutableMap.of()); |
| tester.testAllPublicInstanceMethods(ImmutableMap.of("one", 1)); |
| tester.testAllPublicInstanceMethods(ImmutableMap.of("one", 1, "two", 2, "three", 3)); |
| } |
| |
| private static <K, V> void assertMapEquals(Map<K, V> map, Object... alternatingKeysAndValues) { |
| assertEquals(map.size(), alternatingKeysAndValues.length / 2); |
| int i = 0; |
| for (Entry<K, V> entry : map.entrySet()) { |
| assertEquals(alternatingKeysAndValues[i++], entry.getKey()); |
| assertEquals(alternatingKeysAndValues[i++], entry.getValue()); |
| } |
| } |
| |
| private static class IntHolder implements Serializable { |
| public int value; |
| |
| public IntHolder(int value) { |
| this.value = value; |
| } |
| |
| @Override |
| public boolean equals(Object o) { |
| return (o instanceof IntHolder) && ((IntHolder) o).value == value; |
| } |
| |
| @Override |
| public int hashCode() { |
| return value; |
| } |
| |
| private static final long serialVersionUID = 5; |
| } |
| |
| public void testMutableValues() { |
| IntHolder holderA = new IntHolder(1); |
| IntHolder holderB = new IntHolder(2); |
| Map<String, IntHolder> map = ImmutableMap.of("a", holderA, "b", holderB); |
| holderA.value = 3; |
| assertTrue(map.entrySet().contains(Maps.immutableEntry("a", new IntHolder(3)))); |
| Map<String, Integer> intMap = ImmutableMap.of("a", 3, "b", 2); |
| assertEquals(intMap.hashCode(), map.entrySet().hashCode()); |
| assertEquals(intMap.hashCode(), map.hashCode()); |
| } |
| |
| public void testCopyOfEnumMap() { |
| EnumMap<AnEnum, String> map = new EnumMap<>(AnEnum.class); |
| map.put(AnEnum.B, "foo"); |
| map.put(AnEnum.C, "bar"); |
| assertTrue(ImmutableMap.copyOf(map) instanceof ImmutableEnumMap); |
| } |
| |
| @GwtIncompatible // SerializableTester |
| public void testViewSerialization() { |
| Map<String, Integer> map = ImmutableMap.of("one", 1, "two", 2, "three", 3); |
| LenientSerializableTester.reserializeAndAssertLenient(map.entrySet()); |
| LenientSerializableTester.reserializeAndAssertLenient(map.keySet()); |
| |
| Collection<Integer> reserializedValues = reserialize(map.values()); |
| assertEquals(Lists.newArrayList(map.values()), Lists.newArrayList(reserializedValues)); |
| assertTrue(reserializedValues instanceof ImmutableCollection); |
| } |
| |
| @GwtIncompatible("assumptions about splitting") |
| public void testKeySetSplittable() { |
| ImmutableMap<Integer, Integer> map = |
| ImmutableMap.<Integer, Integer>builder() |
| .put(1, 1) |
| .put(2, 2) |
| .put(3, 3) |
| .put(4, 4) |
| .put(5, 5) |
| .put(6, 6) |
| .build(); |
| assertNotNull(map.keySet().spliterator().trySplit()); |
| } |
| |
| public void testEquals() { |
| new EqualsTester() |
| .addEqualityGroup(ImmutableMap.of(), ImmutableMap.builder().build()) |
| .addEqualityGroup(ImmutableMap.of(1, 1), ImmutableMap.builder().put(1, 1).build()) |
| .addEqualityGroup(ImmutableMap.of(1, 1, 2, 2)) |
| .addEqualityGroup(ImmutableMap.of(1, 1, 2, 2, 3, 3)) |
| .addEqualityGroup(ImmutableMap.of(1, 4, 2, 2, 3, 3)) |
| .addEqualityGroup(ImmutableMap.of(1, 1, 2, 4, 3, 3)) |
| .addEqualityGroup(ImmutableMap.of(1, 1, 2, 2, 3, 4)) |
| .addEqualityGroup(ImmutableMap.of(1, 2, 2, 3, 3, 1)) |
| .addEqualityGroup(ImmutableMap.of(1, 1, 2, 2, 3, 3, 4, 4)) |
| .testEquals(); |
| } |
| |
| /** |
| * A Comparable wrapper around a String which executes callbacks on calls to hashCode, equals, and |
| * compareTo. |
| */ |
| private static class CountsHashCodeAndEquals implements Comparable<CountsHashCodeAndEquals> { |
| private final String delegateString; |
| private final Runnable onHashCode; |
| private final Runnable onEquals; |
| private final Runnable onCompareTo; |
| |
| CountsHashCodeAndEquals( |
| String delegateString, Runnable onHashCode, Runnable onEquals, Runnable onCompareTo) { |
| this.delegateString = delegateString; |
| this.onHashCode = onHashCode; |
| this.onEquals = onEquals; |
| this.onCompareTo = onCompareTo; |
| } |
| |
| @Override |
| public int hashCode() { |
| onHashCode.run(); |
| return delegateString.hashCode(); |
| } |
| |
| @Override |
| public boolean equals(@Nullable Object other) { |
| onEquals.run(); |
| return other instanceof CountsHashCodeAndEquals |
| && delegateString.equals(((CountsHashCodeAndEquals) other).delegateString); |
| } |
| |
| @Override |
| public int compareTo(CountsHashCodeAndEquals o) { |
| onCompareTo.run(); |
| return delegateString.compareTo(o.delegateString); |
| } |
| } |
| |
| /** A holder of counters for calls to hashCode, equals, and compareTo. */ |
| private static final class CallsCounter { |
| long hashCode; |
| long equals; |
| long compareTo; |
| |
| long total() { |
| return hashCode + equals + compareTo; |
| } |
| |
| void zero() { |
| hashCode = 0; |
| equals = 0; |
| compareTo = 0; |
| } |
| } |
| |
| /** All the ways to create an ImmutableMap. */ |
| enum ConstructionPathway { |
| COPY_OF_MAP { |
| @Override |
| ImmutableMap<?, ?> create(List<?> keys, Object value, CallsCounter counter) { |
| Map<Object, Object> sourceMap = new LinkedHashMap<>(); |
| for (Object k : keys) { |
| if (sourceMap.put(k, value) != null) { |
| throw new UnsupportedOperationException("duplicate key"); |
| } |
| } |
| counter.zero(); |
| return ImmutableMap.copyOf(sourceMap); |
| } |
| }, |
| COPY_OF_ENTRIES { |
| @Override |
| ImmutableMap<?, ?> create(List<?> keys, Object value, CallsCounter counter) { |
| return ImmutableMap.copyOf(Lists.transform(keys, k -> Maps.immutableEntry(k, value))); |
| } |
| }, |
| BUILDER_PUT_ONE_BY_ONE { |
| @Override |
| ImmutableMap<?, ?> create(List<?> keys, Object value, CallsCounter counter) { |
| ImmutableMap.Builder<Object, Object> builder = ImmutableMap.builder(); |
| for (Object k : keys) { |
| builder.put(k, value); |
| } |
| return builder.build(); |
| } |
| }, |
| BUILDER_PUT_ENTRIES_ONE_BY_ONE { |
| @Override |
| ImmutableMap<?, ?> create(List<?> keys, Object value, CallsCounter counter) { |
| ImmutableMap.Builder<Object, Object> builder = ImmutableMap.builder(); |
| for (Object k : keys) { |
| builder.put(Maps.immutableEntry(k, value)); |
| } |
| return builder.build(); |
| } |
| }, |
| BUILDER_PUT_ALL_MAP { |
| @Override |
| ImmutableMap<?, ?> create(List<?> keys, Object value, CallsCounter counter) { |
| Map<Object, Object> sourceMap = new LinkedHashMap<>(); |
| for (Object k : keys) { |
| if (sourceMap.put(k, value) != null) { |
| throw new UnsupportedOperationException("duplicate key"); |
| } |
| } |
| counter.zero(); |
| return ImmutableMap.builder().putAll(sourceMap).build(); |
| } |
| }, |
| BUILDER_PUT_ALL_ENTRIES { |
| @Override |
| ImmutableMap<?, ?> create(List<?> keys, Object value, CallsCounter counter) { |
| return ImmutableMap.builder() |
| .putAll(Lists.transform(keys, k -> Maps.immutableEntry(k, value))) |
| .build(); |
| } |
| }, |
| FORCE_JDK { |
| @Override |
| ImmutableMap<?, ?> create(List<?> keys, Object value, CallsCounter counter) { |
| ImmutableMap.Builder<Object, Object> builder = ImmutableMap.builder(); |
| for (Object k : keys) { |
| builder.put(k, value); |
| } |
| return builder.buildJdkBacked(); |
| } |
| }; |
| |
| @CanIgnoreReturnValue |
| abstract ImmutableMap<?, ?> create(List<?> keys, Object value, CallsCounter counter); |
| } |
| |
| /** |
| * Returns a list of objects with the same hash code, of size 2^power, counting calls to equals, |
| * hashCode, and compareTo in counter. |
| */ |
| static List<CountsHashCodeAndEquals> createAdversarialInput(int power, CallsCounter counter) { |
| String str1 = "Aa"; |
| String str2 = "BB"; |
| assertEquals(str1.hashCode(), str2.hashCode()); |
| List<String> haveSameHashes2 = Arrays.asList(str1, str2); |
| List<CountsHashCodeAndEquals> result = |
| Lists.newArrayList( |
| Lists.transform( |
| Lists.cartesianProduct(Collections.nCopies(power, haveSameHashes2)), |
| strs -> |
| new CountsHashCodeAndEquals( |
| String.join("", strs), |
| () -> counter.hashCode++, |
| () -> counter.equals++, |
| () -> counter.compareTo++))); |
| assertEquals( |
| result.get(0).delegateString.hashCode(), |
| result.get(result.size() - 1).delegateString.hashCode()); |
| return result; |
| } |
| |
| @GwtIncompatible |
| public void testResistsHashFloodingInConstruction() { |
| CallsCounter smallCounter = new CallsCounter(); |
| List<CountsHashCodeAndEquals> haveSameHashesSmall = createAdversarialInput(10, smallCounter); |
| int smallSize = haveSameHashesSmall.size(); |
| |
| CallsCounter largeCounter = new CallsCounter(); |
| List<CountsHashCodeAndEquals> haveSameHashesLarge = createAdversarialInput(15, largeCounter); |
| int largeSize = haveSameHashesLarge.size(); |
| |
| for (ConstructionPathway pathway : ConstructionPathway.values()) { |
| smallCounter.zero(); |
| pathway.create(haveSameHashesSmall, "valueObject", smallCounter); |
| long smallOps = smallCounter.total(); |
| |
| largeCounter.zero(); |
| pathway.create(haveSameHashesLarge, "valueObject", largeCounter); |
| long largeOps = largeCounter.total(); |
| |
| double ratio = (double) largeOps / smallOps; |
| assertThat(ratio) |
| .named( |
| "ratio of equals/hashCode/compareTo operations to build an ImmutableMap via %s" |
| + " with %s entries versus %s entries", |
| pathway, largeSize, smallSize) |
| .isAtMost(2 * (largeSize * Math.log(largeSize)) / (smallSize * Math.log(smallSize))); |
| // allow up to 2x wobble in the constant factors |
| } |
| } |
| |
| @GwtIncompatible |
| public void testResistsHashFloodingOnGet() { |
| CallsCounter smallCounter = new CallsCounter(); |
| List<CountsHashCodeAndEquals> haveSameHashesSmall = createAdversarialInput(10, smallCounter); |
| int smallSize = haveSameHashesSmall.size(); |
| ImmutableMap<?, ?> smallMap = |
| ConstructionPathway.BUILDER_PUT_ONE_BY_ONE.create( |
| haveSameHashesSmall, "valueObject", smallCounter); |
| long worstCaseQuerySmall = worstCaseQueryOperations(smallMap, smallCounter); |
| |
| CallsCounter largeCounter = new CallsCounter(); |
| List<CountsHashCodeAndEquals> haveSameHashesLarge = createAdversarialInput(15, largeCounter); |
| int largeSize = haveSameHashesLarge.size(); |
| ImmutableMap<?, ?> largeMap = |
| ConstructionPathway.BUILDER_PUT_ONE_BY_ONE.create( |
| haveSameHashesLarge, "valueObject", largeCounter); |
| long worstCaseQueryLarge = worstCaseQueryOperations(largeMap, largeCounter); |
| |
| double ratio = (double) worstCaseQueryLarge / worstCaseQuerySmall; |
| assertThat(ratio) |
| .named( |
| "Ratio of worst case query operations for an ImmutableMap of size %s versus %s", |
| largeSize, smallSize) |
| .isAtMost(2 * Math.log(largeSize) / Math.log(smallSize)); |
| // allow up to 2x wobble in the constant factors |
| } |
| |
| private static long worstCaseQueryOperations(Map<?, ?> map, CallsCounter counter) { |
| long worstCalls = 0; |
| for (Object k : map.keySet()) { |
| counter.zero(); |
| Object unused = map.get(k); |
| worstCalls = Math.max(worstCalls, counter.total()); |
| } |
| return worstCalls; |
| } |
| |
| public void testCopyOfMutableEntryList() { |
| List<Entry<String, String>> entryList = |
| Arrays.asList( |
| new AbstractMap.SimpleEntry<>("a", "1"), new AbstractMap.SimpleEntry<>("b", "2")); |
| ImmutableMap<String, String> map = ImmutableMap.copyOf(entryList); |
| assertThat(map).containsExactly("a", "1", "b", "2").inOrder(); |
| entryList.get(0).setValue("3"); |
| assertThat(map).containsExactly("a", "1", "b", "2").inOrder(); |
| } |
| |
| public void testBuilderPutAllEntryList() { |
| List<Entry<String, String>> entryList = |
| Arrays.asList( |
| new AbstractMap.SimpleEntry<>("a", "1"), new AbstractMap.SimpleEntry<>("b", "2")); |
| ImmutableMap<String, String> map = |
| ImmutableMap.<String, String>builder().putAll(entryList).build(); |
| assertThat(map).containsExactly("a", "1", "b", "2").inOrder(); |
| entryList.get(0).setValue("3"); |
| assertThat(map).containsExactly("a", "1", "b", "2").inOrder(); |
| } |
| |
| public void testBuilderPutAllEntryListJdkBacked() { |
| List<Entry<String, String>> entryList = |
| Arrays.asList( |
| new AbstractMap.SimpleEntry<>("a", "1"), new AbstractMap.SimpleEntry<>("b", "2")); |
| ImmutableMap<String, String> map = |
| ImmutableMap.<String, String>builder().putAll(entryList).buildJdkBacked(); |
| assertThat(map).containsExactly("a", "1", "b", "2").inOrder(); |
| entryList.get(0).setValue("3"); |
| assertThat(map).containsExactly("a", "1", "b", "2").inOrder(); |
| } |
| } |
