1090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson/* 21d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * Copyright (C) 2007 The Guava Authors 3090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson * 4090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson * Licensed under the Apache License, Version 2.0 (the "License"); 5090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson * you may not use this file except in compliance with the License. 6090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson * You may obtain a copy of the License at 7090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson * 8090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson * http://www.apache.org/licenses/LICENSE-2.0 9090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson * 10090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson * Unless required by applicable law or agreed to in writing, software 11090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson * distributed under the License is distributed on an "AS IS" BASIS, 12090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson * See the License for the specific language governing permissions and 14090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson * limitations under the License. 15090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson */ 16090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson 17090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilsonpackage com.google.common.collect; 18090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson 19090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilsonimport com.google.common.annotations.GwtCompatible; 20090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson 21090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilsonimport java.util.HashMap; 22090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilsonimport java.util.Map; 23090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson 24090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilsonimport javax.annotation.Nullable; 25090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson 26090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson/** 27090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson * A {@link BiMap} backed by two {@link HashMap} instances. This implementation 28090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson * allows null keys and values. A {@code HashBiMap} and its inverse are both 29090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson * serializable. 30090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson * 31090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson * @author Mike Bostock 321d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * @since 2.0 (imported from Google Collections Library) 33090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson */ 341d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert@GwtCompatible(emulated = true) 35090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilsonpublic final class HashBiMap<K, V> extends AbstractBiMap<K, V> { 36090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson 37090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson /** 38090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson * Returns a new, empty {@code HashBiMap} with the default initial capacity 39090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson * (16). 40090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson */ 41090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson public static <K, V> HashBiMap<K, V> create() { 42090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson return new HashBiMap<K, V>(); 43090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson } 44090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson 45090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson /** 46090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson * Constructs a new, empty bimap with the specified expected size. 47090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson * 48090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson * @param expectedSize the expected number of entries 49090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson * @throws IllegalArgumentException if the specified expected size is 50090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson * negative 51090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson */ 52090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson public static <K, V> HashBiMap<K, V> create(int expectedSize) { 53090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson return new HashBiMap<K, V>(expectedSize); 54090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson } 55090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson 56090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson /** 57090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson * Constructs a new bimap containing initial values from {@code map}. The 58090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson * bimap is created with an initial capacity sufficient to hold the mappings 59090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson * in the specified map. 60090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson */ 61090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson public static <K, V> HashBiMap<K, V> create( 62090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson Map<? extends K, ? extends V> map) { 63090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson HashBiMap<K, V> bimap = create(map.size()); 64090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson bimap.putAll(map); 65090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson return bimap; 66090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson } 67090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson 68090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson private HashBiMap() { 69090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson super(new HashMap<K, V>(), new HashMap<V, K>()); 70090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson } 71090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson 72090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson private HashBiMap(int expectedSize) { 731d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert super( 741d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert Maps.<K, V>newHashMapWithExpectedSize(expectedSize), 751d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert Maps.<V, K>newHashMapWithExpectedSize(expectedSize)); 76090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson } 77090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson 78090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson // Override these two methods to show that keys and values may be null 79090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson 80090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson @Override public V put(@Nullable K key, @Nullable V value) { 81090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson return super.put(key, value); 82090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson } 83090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson 84090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson @Override public V forcePut(@Nullable K key, @Nullable V value) { 85090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson return super.forcePut(key, value); 86090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson } 87090f9b4c879985bc747c214f82c62471e60c7742Jesse Wilson} 881d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 89