11d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert/* 21d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * Copyright (C) 2010 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; 181d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 191d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport com.google.common.annotations.Beta; 201d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport com.google.common.annotations.GwtCompatible; 211d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport com.google.common.annotations.GwtIncompatible; 221d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport com.google.common.base.Equivalence; 231d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport com.google.common.base.Function; 241d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport com.google.common.base.Objects; 251d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport com.google.common.collect.MapMaker.RemovalListener; 261d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport com.google.common.collect.MapMaker.RemovalNotification; 271d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 281d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport java.util.concurrent.ConcurrentMap; 291d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport java.util.concurrent.TimeUnit; 301d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 311d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert/** 321d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * A class exactly like {@link MapMaker}, except restricted in the types of maps it can build. 331d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * For the most part, you should probably just ignore the existence of this class. 341d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * 351d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * @paramthe base type for all key types of maps built by this map maker 361d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * @param the base type for all value types of maps built by this map maker 371d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * @author Kevin Bourrillion 381d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * @since 7.0 391d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert */ 401d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert@Beta 411d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert@GwtCompatible(emulated = true) 421d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertpublic abstract class GenericMapMaker<K0, V0> { 431d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @GwtIncompatible("To be supported") 441d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert enum NullListener implements RemovalListener<Object, Object> { 451d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert INSTANCE; 461d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 471d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @Override 481d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert public void onRemoval(RemovalNotification<Object, Object> notification) {} 491d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 501d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 511d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert // Set by MapMaker, but sits in this class to preserve the type relationship 521d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @GwtIncompatible("To be supported") 531d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert RemovalListener<K0, V0> removalListener; 541d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 551d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert // No subclasses but our own 561d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert GenericMapMaker() {} 571d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 581d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert /** 591d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * See {@link MapMaker#keyEquivalence}. 601d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert */ 611d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @GwtIncompatible("To be supported") 621d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert abstract GenericMapMaker<K0, V0> keyEquivalence(Equivalence<Object> equivalence); 631d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 641d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert /** 651d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * See {@link MapMaker#valueEquivalence}. 661d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert */ 671d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @GwtIncompatible("To be supported") 681d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert abstract GenericMapMaker<K0, V0> valueEquivalence(Equivalence<Object> equivalence); 691d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 701d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert /** 711d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * See {@link MapMaker#initialCapacity}. 721d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert */ 731d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert public abstract GenericMapMaker<K0, V0> initialCapacity(int initialCapacity); 741d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 751d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert /** 761d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * See {@link MapMaker#maximumSize}. 771d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert */ 781d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert abstract GenericMapMaker<K0, V0> maximumSize(int maximumSize); 791d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 801d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert /** 811d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * See {@link MapMaker#strongKeys}. 821d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert */ 831d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert abstract GenericMapMaker<K0, V0> strongKeys(); 841d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 851d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert /** 861d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * See {@link MapMaker#concurrencyLevel}. 871d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert */ 881d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert public abstract GenericMapMaker<K0, V0> concurrencyLevel(int concurrencyLevel); 891d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 901d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert /** 911d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * See {@link MapMaker#weakKeys}. 921d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert */ 931d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @GwtIncompatible("java.lang.ref.WeakReference") 941d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert public abstract GenericMapMaker<K0, V0> weakKeys(); 951d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 961d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert /** 971d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * See {@link MapMaker#strongValues}. 981d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert */ 991d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert abstract GenericMapMaker<K0, V0> strongValues(); 1001d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 1011d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert /** 1021d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * See {@link MapMaker#softKeys}. 1031d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert */ 1041d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @Deprecated 1051d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @GwtIncompatible("java.lang.ref.SoftReference") 1061d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert public abstract GenericMapMaker<K0, V0> softKeys(); 1071d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 1081d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert /** 1091d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * See {@link MapMaker#weakValues}. 1101d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert */ 1111d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @GwtIncompatible("java.lang.ref.WeakReference") 1121d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert public abstract GenericMapMaker<K0, V0> weakValues(); 1131d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 1141d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert /** 1151d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * See {@link MapMaker#softValues}. 1161d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert */ 1171d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @GwtIncompatible("java.lang.ref.SoftReference") 1181d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert public abstract GenericMapMaker<K0, V0> softValues(); 1191d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 1201d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert /** 1211d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * See {@link MapMaker#expiration}. 1221d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert */ 1231d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @Deprecated 1241d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert public 1251d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert abstract GenericMapMaker<K0, V0> expiration(long duration, TimeUnit unit); 1261d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 1271d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert /** 1281d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * See {@link MapMaker#expireAfterWrite}. 1291d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert */ 1301d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert abstract GenericMapMaker<K0, V0> expireAfterWrite(long duration, TimeUnit unit); 1311d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 1321d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert /** 1331d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * See {@link MapMaker#expireAfterAccess}. 1341d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert */ 1351d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @GwtIncompatible("To be supported") 1361d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert abstract GenericMapMaker<K0, V0> expireAfterAccess(long duration, TimeUnit unit); 1371d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 1381d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert /* 1391d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * Note that MapMaker's removalListener() is not here, because once you're interacting with a 1401d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * GenericMapMaker you've already called that, and shouldn't be calling it again. 1411d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert */ 1421d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 1431d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @SuppressWarnings("unchecked") // safe covariant cast 1441d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @GwtIncompatible("To be supported") 1451d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert <K extends K0, V extends V0> RemovalListener<K, V> getRemovalListener() { 1461d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert return (RemovalListener<K, V>) Objects.firstNonNull(removalListener, NullListener.INSTANCE); 1471d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 1481d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 1491d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert /** 1501d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * See {@link MapMaker#makeMap}. 1511d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert */ 1521d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert public abstract <K extends K0, V extends V0> ConcurrentMap<K, V> makeMap(); 1531d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 1541d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert /** 1551d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * See {@link MapMaker#makeCustomMap}. 1561d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert */ 1571d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @GwtIncompatible("MapMakerInternalMap") 1581d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert abstract <K, V> MapMakerInternalMap<K, V> makeCustomMap(); 1591d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 1601d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert /** 1611d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * See {@link MapMaker#makeComputingMap}. 1621d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert */ 1631d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @Deprecated 1641d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert public abstract <K extends K0, V extends V0> ConcurrentMap<K, V> makeComputingMap( 1651d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert Function<? super K, ? extends V> computingFunction); 1661d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert} 167