org.elasticsearch.common.util

Class SingleObjectCache<T>

java.lang.Object

org.elasticsearch.common.util.SingleObjectCache<T>

public abstract class SingleObjectCache<T>
extends Object

A very simple single object cache that allows non-blocking refresh calls triggered by expiry time.

Field Summary

Fields

Modifier and Type	Field and Description
protected long	lastRefreshTimestamp

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SingleObjectCache(TimeValue refreshInterval, T initialValue)

Method Summary

Methods

Modifier and Type	Method and Description
T	getOrRefresh() Returns the currently cached object and potentially refreshes the cache before returning.
protected boolean	needsRefresh() Returns true iff the cache needs to be refreshed.
protected abstract T	refresh() Returns a new instance to cache

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

lastRefreshTimestamp

protected long lastRefreshTimestamp

Constructor Detail

SingleObjectCache

protected SingleObjectCache(TimeValue refreshInterval,
                 T initialValue)

Method Detail

getOrRefresh

public T getOrRefresh()

Returns the currently cached object and potentially refreshes the cache before returning.

refresh

protected abstract T refresh()

Returns a new instance to cache

needsRefresh

protected boolean needsRefresh()

Returns true iff the cache needs to be refreshed.