public interface SolrCache<K,V> extends SolrInfoBean, SolrMetricProducer
Modifier and Type | Interface and Description |
---|---|
static class |
SolrCache.State
Enumeration of possible States for cache instances.
|
SolrInfoBean.Category, SolrInfoBean.Group
Modifier and Type | Method and Description |
---|---|
void |
clear()
:TODO: copy from Map
|
void |
close()
Frees any non-memory resources
|
V |
get(K key)
:TODO: copy from Map
|
SolrCache.State |
getState()
Returns the last State set on this instance
|
Object |
init(Map args,
Object persistence,
CacheRegenerator regenerator)
The initialization routine.
|
String |
name()
Name the Cache can be referenced with by SolrRequestHandlers.
|
V |
put(K key,
V value)
:TODO: copy from Map
|
void |
setState(SolrCache.State state)
Set different cache states.
|
int |
size()
:TODO: copy from Map
|
void |
warm(SolrIndexSearcher searcher,
SolrCache<K,V> old)
Warm this cache associated with
searcher using the old
cache object. |
getCategory, getDescription, getMetricNames, getMetricRegistry, getMetricsSnapshot, getName, registerMetricName
initializeMetrics
Object init(Map args, Object persistence, CacheRegenerator regenerator)
args
map.
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 CacheRegenerator
is what the cache uses during auto-warming to
regenerate an item in the new cache from an entry in the old cache.
String name()
int size()
void clear()
void setState(SolrCache.State state)
SolrCache.State getState()
void warm(SolrIndexSearcher searcher, SolrCache<K,V> old)
searcher
using the old
cache object. this
and old
will have the same concrete type.void close()
Copyright © 2000-2017 Apache Software Foundation. All Rights Reserved.