Class LRUCache<K,V>
- java.lang.Object
-
- org.apache.solr.search.SolrCacheBase
-
- org.apache.solr.search.LRUCache<K,V>
-
- All Implemented Interfaces:
AutoCloseable,org.apache.lucene.util.Accountable,SolrInfoBean,SolrMetricProducer,SolrCache<K,V>
public class LRUCache<K,V> extends SolrCacheBase implements SolrCache<K,V>, org.apache.lucene.util.Accountable
Deprecated.This cache implementation is deprecated and will be removed in Solr 9.0. UseCaffeineCacheinstead.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classLRUCache.CacheValue<V>Deprecated.-
Nested classes/interfaces inherited from class org.apache.solr.search.SolrCacheBase
SolrCacheBase.AutoWarmCountRef
-
Nested classes/interfaces inherited from interface org.apache.solr.search.SolrCache
SolrCache.State
-
Nested classes/interfaces inherited from interface org.apache.solr.core.SolrInfoBean
SolrInfoBean.Category, SolrInfoBean.Group
-
-
Field Summary
-
Fields inherited from class org.apache.solr.search.SolrCacheBase
autowarm, regenerator
-
Fields inherited from interface org.apache.solr.search.SolrCache
CLEANUP_THREAD_PARAM, EVICTIONS_PARAM, HIT_RATIO_PARAM, HITS_PARAM, INITIAL_SIZE_PARAM, INSERTS_PARAM, LOOKUPS_PARAM, MAX_IDLE_TIME_PARAM, MAX_RAM_MB_PARAM, MAX_SIZE_PARAM, RAM_BYTES_USED_PARAM, SHOW_ITEMS_PARAM, SIZE_PARAM
-
-
Constructor Summary
Constructors Constructor Description LRUCache()Deprecated.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description voidclear()Deprecated.:TODO: copy from MapVcomputeIfAbsent(K key, Function<? super K,? extends V> mappingFunction)Deprecated.Get an existing element or atomically compute it if missing.Vget(K key)Deprecated.:TODO: copy from MapCollection<org.apache.lucene.util.Accountable>getChildResources()Deprecated.StringgetDescription()Deprecated.Simple one or two line descriptionlonggetMaxRamBytes()Deprecated.intgetMaxRamMB()Deprecated.Returns maximum size limit (in MB) if set and supported, -1 otherwise.intgetMaxSize()Deprecated.Returns maximum size limit (number of items) if set and supported, -1 otherwise.Set<String>getMetricNames()Deprecated.Modifiable set of metric names that this component reports (default is null, which means none).StringgetName()Deprecated.Simple common usage name, e.g.SolrMetricsContextgetSolrMetricsContext()Deprecated.Implementing classes should override this method to provide the context obtained inSolrMetricProducer.initializeMetrics(SolrMetricsContext, String)to ensure proper cleanup of metrics at the end of the life-cycle of this component.Objectinit(Map args, Object persistence, CacheRegenerator regenerator)Deprecated.The initialization routine.voidinitializeMetrics(SolrMetricsContext parentContext, String scope)Deprecated.Initialize metrics specific to this producer.Vput(K key, V value)Deprecated.:TODO: copy from MapVputCacheValue(K key, LRUCache.CacheValue<V> cacheValue)Deprecated.Visible for testing to create synthetic cache entries.longramBytesUsed()Deprecated.Vremove(K key)Deprecated.voidsetMaxRamMB(int maxRamMB)Deprecated.Set maximum size limit (in MB), or -1 for unlimited.voidsetMaxSize(int maxSize)Deprecated.Set maximum size limit (number of items), or -1 for unlimited.voidsetSyntheticEntries(boolean syntheticEntries)Deprecated.Visible for testing.intsize()Deprecated.:TODO: copy from MapStringtoString()Deprecated.voidwarm(SolrIndexSearcher searcher, SolrCache<K,V> old)Deprecated.Warm this cache associated withsearcherusing theoldcache object.-
Methods inherited from class org.apache.solr.search.SolrCacheBase
calcHitRatio, getAutowarmDescription, getCategory, getState, getVersion, init, isAutowarmingOn, name, setState
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.apache.solr.core.SolrInfoBean
getCategory, getMetricRegistry, getMetricsSnapshot, registerMetricName
-
Methods inherited from interface org.apache.solr.metrics.SolrMetricProducer
initializeMetrics
-
-
-
-
Method Detail
-
init
public Object init(Map args, Object persistence, CacheRegenerator regenerator)
Deprecated.Description copied from interface:SolrCacheThe initialization routine. Instance specific arguments are passed in theargsmap.The persistence object will exist across different lifetimes of similar caches. For example, all filter caches will share the same persistence object, sometimes at the same time (it must be thread-safe). If null is passed, then the cache implementation should create and return a new persistence object. If not null, the passed in object should be returned again.
Since it will exist across the lifetime of many caches, care should be taken to not reference any particular cache instance and prevent it from being garbage collected (no using inner classes unless they are static).
The persistence object is designed to be used as a way for statistics to accumulate across all instances of the same type of cache, however the object may be of any type desired by the cache implementation.
The
CacheRegeneratoris what the cache uses during auto-warming to regenerate an item in the new cache from an entry in the old cache.
-
setSyntheticEntries
public void setSyntheticEntries(boolean syntheticEntries)
Deprecated.Visible for testing. This flag tells the eviction code that (unlike with real entries) there's no guarantee on the order of entries being inserted with monotonically ascending creation time. Setting this to true causes a full sweep when looking for entries to evict.- NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.
-
getMaxRamBytes
public long getMaxRamBytes()
Deprecated.
-
size
public int size()
Deprecated.Description copied from interface:SolrCache:TODO: copy from Map
-
computeIfAbsent
public V computeIfAbsent(K key, Function<? super K,? extends V> mappingFunction)
Deprecated.Description copied from interface:SolrCacheGet an existing element or atomically compute it if missing.- Specified by:
computeIfAbsentin interfaceSolrCache<K,V>- Parameters:
key- keymappingFunction- function to compute the element. If the function returns a null result the cache mapping will not be created. NOTE: this function must NOT attempt to modify any mappings in the cache.- Returns:
- existing or newly computed value, null if there was no existing value and it was not possible to compute a new value (in which case the new mapping won't be created).
-
put
public V put(K key, V value)
Deprecated.Description copied from interface:SolrCache:TODO: copy from Map
-
putCacheValue
public V putCacheValue(K key, LRUCache.CacheValue<V> cacheValue)
Deprecated.Visible for testing to create synthetic cache entries.- NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.
-
get
public V get(K key)
Deprecated.Description copied from interface:SolrCache:TODO: copy from Map
-
clear
public void clear()
Deprecated.Description copied from interface:SolrCache:TODO: copy from Map
-
warm
public void warm(SolrIndexSearcher searcher, SolrCache<K,V> old)
Deprecated.Description copied from interface:SolrCacheWarm this cache associated withsearcherusing theoldcache object.thisandoldwill have the same concrete type.
-
getName
public String getName()
Deprecated.Description copied from interface:SolrInfoBeanSimple common usage name, e.g. BasicQueryHandler, or fully qualified class name.- Specified by:
getNamein interfaceSolrInfoBean
-
getDescription
public String getDescription()
Deprecated.Description copied from interface:SolrInfoBeanSimple one or two line description- Specified by:
getDescriptionin interfaceSolrInfoBean
-
getMetricNames
public Set<String> getMetricNames()
Deprecated.Description copied from interface:SolrInfoBeanModifiable set of metric names that this component reports (default is null, which means none). If not null then this set is used bySolrInfoBean.registerMetricName(String)to capture what metrics names are reported from this component.NOTE: this set has to allow iteration under modifications.
- Specified by:
getMetricNamesin interfaceSolrInfoBean
-
getSolrMetricsContext
public SolrMetricsContext getSolrMetricsContext()
Deprecated.Description copied from interface:SolrMetricProducerImplementing classes should override this method to provide the context obtained inSolrMetricProducer.initializeMetrics(SolrMetricsContext, String)to ensure proper cleanup of metrics at the end of the life-cycle of this component.- Specified by:
getSolrMetricsContextin interfaceSolrMetricProducer
-
initializeMetrics
public void initializeMetrics(SolrMetricsContext parentContext, String scope)
Deprecated.Description copied from interface:SolrMetricProducerInitialize metrics specific to this producer.- Specified by:
initializeMetricsin interfaceSolrMetricProducer- Parameters:
parentContext- parent metrics context. If this component has the same life-cycle as the parent it can simply use the parent context, otherwise it should obtain a child context usingSolrMetricsContext.getChildContext(Object)passingthisas the child.scope- component scope
-
ramBytesUsed
public long ramBytesUsed()
Deprecated.- Specified by:
ramBytesUsedin interfaceorg.apache.lucene.util.Accountable
-
getChildResources
public Collection<org.apache.lucene.util.Accountable> getChildResources()
Deprecated.- Specified by:
getChildResourcesin interfaceorg.apache.lucene.util.Accountable
-
getMaxSize
public int getMaxSize()
Deprecated.Description copied from interface:SolrCacheReturns maximum size limit (number of items) if set and supported, -1 otherwise.- Specified by:
getMaxSizein interfaceSolrCache<K,V>
-
setMaxSize
public void setMaxSize(int maxSize)
Deprecated.Description copied from interface:SolrCacheSet maximum size limit (number of items), or -1 for unlimited. Note: this has effect only on implementations that support it, it's a no-op otherwise- Specified by:
setMaxSizein interfaceSolrCache<K,V>
-
getMaxRamMB
public int getMaxRamMB()
Deprecated.Description copied from interface:SolrCacheReturns maximum size limit (in MB) if set and supported, -1 otherwise.- Specified by:
getMaxRamMBin interfaceSolrCache<K,V>
-
setMaxRamMB
public void setMaxRamMB(int maxRamMB)
Deprecated.Description copied from interface:SolrCacheSet maximum size limit (in MB), or -1 for unlimited. Note: this has effect only on implementations that support it, it's a no-op otherwise.- Specified by:
setMaxRamMBin interfaceSolrCache<K,V>
-
-