11d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert/* 21d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * Copyright (C) 2011 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.cache; 181d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 191d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport com.google.common.annotations.Beta; 201d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 211d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport java.util.Iterator; 221d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport java.util.Map; 231d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport java.util.concurrent.ConcurrentMap; 241d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 251d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert/** 261d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * The reason why a cached entry was removed. 271d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * 281d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * @author Charles Fry 291d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * @since 10.0 301d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert */ 311d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert@Beta 321d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertpublic enum RemovalCause { 331d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert /** 341d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * The entry was manually removed by the user. This can result from the user invoking 351d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * {@link Cache#invalidate}, {@link Cache#invalidateAll(Iterable)}, {@link Cache#invalidateAll()}, 361d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * {@link Map#remove}, {@link ConcurrentMap#remove}, or {@link Iterator#remove}. 371d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert */ 381d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert EXPLICIT { 391d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @Override 401d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert boolean wasEvicted() { 411d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert return false; 421d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 431d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert }, 441d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 451d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert /** 461d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * The entry itself was not actually removed, but its value was replaced by the user. This can 471d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * result from the user invoking {@link Cache#put}, {@link LoadingCache#refresh}, {@link Map#put}, 481d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * {@link Map#putAll}, {@link ConcurrentMap#replace(Object, Object)}, or 491d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * {@link ConcurrentMap#replace(Object, Object, Object)}. 501d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert */ 511d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert REPLACED { 521d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @Override 531d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert boolean wasEvicted() { 541d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert return false; 551d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 561d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert }, 571d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 581d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert /** 591d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * The entry was removed automatically because its key or value was garbage-collected. This 601d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * can occur when using {@link CacheBuilder#weakKeys}, {@link CacheBuilder#weakValues}, or 611d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * {@link CacheBuilder#softValues}. 621d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert */ 631d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert COLLECTED { 641d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @Override 651d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert boolean wasEvicted() { 661d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert return true; 671d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 681d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert }, 691d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 701d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert /** 711d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * The entry's expiration timestamp has passed. This can occur when using 721d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * {@link CacheBuilder#expireAfterWrite} or {@link CacheBuilder#expireAfterAccess}. 731d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert */ 741d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert EXPIRED { 751d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @Override 761d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert boolean wasEvicted() { 771d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert return true; 781d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 791d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert }, 801d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 811d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert /** 821d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * The entry was evicted due to size constraints. This can occur when using 831d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * {@link CacheBuilder#maximumSize} or {@link CacheBuilder#maximumWeight}. 841d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert */ 851d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert SIZE { 861d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @Override 871d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert boolean wasEvicted() { 881d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert return true; 891d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 901d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert }; 911d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 921d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert /** 931d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * Returns {@code true} if there was an automatic removal due to eviction (the cause is neither 941d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * {@link #EXPLICIT} nor {@link #REPLACED}). 951d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert */ 961d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert abstract boolean wasEvicted(); 971d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert} 98