nablarch.core.cache.expirable

クラス ExpirableCacheTemplate<K,V>

java.lang.Object

nablarch.core.cache.expirable.ExpirableCacheTemplate<K,V>

型パラメータ:

K - キャッシュキー

V - キャッシュ値

すべての実装されたインタフェース:

ExpirableCache<K,V>

直系の既知のサブクラス:

InMemoryExpirableCache

@Published(tag="architect")
public abstract class ExpirableCacheTemplate<K,V>
extends java.lang.Object
implements ExpirableCache<K,V>

有効期限付きキャッシュ(ExpirableCache)を実装するためのテンプレートクラス。 有効期限付きキャッシュの基本的な枠組みを提供する。 サブクラスにて、具体的な格納先（Map、KVS等）へのアクセス処理を実装する。

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
protected static java.util.Date	UNLIMITED 有効期限無しを表す日時

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
ExpirableCacheTemplate()

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	add(K key, V value, java.util.Date timeout) キャッシュに値を設定する。
protected abstract void	addToCache(K key, Expirable<V> expirable) キャッシュに値を設定する。
void	addUnlimited(K key, V value) キャッシュに有効期限無しで値を設定する。
void	clear() キャッシュをクリアする。
protected abstract void	clearCache() キャッシュの全エントリを削除する。
protected abstract Expirable<V>	getFromCache(K key) キャッシュから値を取得する。
V	getIfNotExpired(K key) キャッシュから値を取得する。
protected java.util.Date	getNowDate() 現在日時を取得する。
void	remove(K key) キャッシュから値を削除する。
protected abstract Expirable<V>	removeFromCache(K key) 指定したキーに対応するエントリを削除する。
void	setCacheListener(ExpirableCacheListener<K> listener) キャッシュリスナークラスを設定する。
void	setSystemTimeProvider(SystemTimeProvider systemTimeProvider) システム日時提供クラスを取得する。

クラスから継承されたメソッド java.lang.Object

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

フィールドの詳細

UNLIMITED

protected static final java.util.Date UNLIMITED

有効期限無しを表す日時

コンストラクタの詳細

ExpirableCacheTemplate

public ExpirableCacheTemplate()

メソッドの詳細

getNowDate

protected final java.util.Date getNowDate()

現在日時を取得する。

戻り値:

現在日時

getIfNotExpired

public V getIfNotExpired(K key)

キャッシュから値を取得する。 キャッシュに値が存在しない場合または有効期限切れの場合はnullを返却する。

定義:

getIfNotExpired インタフェース内 ExpirableCache<K,V>

パラメータ:

key - キャッシュキー

戻り値:

キャッシュされた値

add

public void add(K key,
                V value,
                java.util.Date timeout)

キャッシュに値を設定する。

定義:

add インタフェース内 ExpirableCache<K,V>

パラメータ:

key - キャッシュキー

value - キャッシュされる値

timeout - 有効期限

addUnlimited

public void addUnlimited(K key,
                         V value)

キャッシュに有効期限無しで値を設定する。

定義:

addUnlimited インタフェース内 ExpirableCache<K,V>

パラメータ:

key - キャッシュキー

value - キャッシュされる値

remove

public void remove(K key)

キャッシュから値を削除する。

定義:

remove インタフェース内 ExpirableCache<K,V>

パラメータ:

key - 削除対象キャッシュキー

clear

public void clear()

キャッシュをクリアする。

定義:

clear インタフェース内 ExpirableCache<K,V>

setCacheListener

public void setCacheListener(ExpirableCacheListener<K> listener)

キャッシュリスナークラスを設定する。 本インタフェース実装クラスは、各イベント発生時にこのリスナーをコールバックする。

定義:

setCacheListener インタフェース内 ExpirableCache<K,V>

パラメータ:

listener - リスナークラス。

getFromCache

protected abstract Expirable<V> getFromCache(K key)

キャッシュから値を取得する。

パラメータ:

key - キー

戻り値:

キーに対応する値を格納したExpirable

removeFromCache

protected abstract Expirable<V> removeFromCache(K key)

指定したキーに対応するエントリを削除する。

パラメータ:

key - キー

戻り値:

キーに対応する値を格納したExpirable

addToCache

protected abstract void addToCache(K key,
                                   Expirable<V> expirable)

キャッシュに値を設定する。

パラメータ:

key - キー

expirable - 値を格納したExpirable

clearCache

protected abstract void clearCache()

キャッシュの全エントリを削除する。

setSystemTimeProvider

public void setSystemTimeProvider(SystemTimeProvider systemTimeProvider)

システム日時提供クラスを取得する。

パラメータ:

systemTimeProvider - システム日時提供クラス