nablarch.core.util.map

クラス CopyOnReadMap<K,V>

java.lang.Object

java.util.AbstractMap<K,V>

nablarch.core.util.map.MapWrapper<K,V>

nablarch.core.util.map.CopyOnReadMap<K,V>

型パラメータ:

K - キーの型

V - 値の型

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

java.util.Map<K,V>

public class CopyOnReadMap<K,V>
extends MapWrapper<K,V>

スレッド毎のスナップショットを作成することで、並行アクセスに対する一貫読み取りおよび、 楽観ロック方式による書き込みを行うラッパークラス。

 リクエストスレッドがセッション上の変数にアクセスした時点で、
 セッションのスナップショット（ディープコピー）をスレッドローカル変数上に作成する。
 以降、当該リクエストスレッドからのアクセスはこのスナップショットに対して行われる。
 リクエスト終了時にスナップショット上の変更をもとのセッションにマージするが、
 この際、他のリクエストスレッドによってセッションが既に書き換えられていた場合は
 ConcurrentModificationException を送出する。
 また、セッションの直列化に失敗した場合は CopyOnReadMap.SnapshotCreationError
 を送出する。
 

ネストされたクラスのサマリー

ネストされたクラス

修飾子とタイプ	クラスと説明
static class	CopyOnReadMap.SnapshotCreationError マップ内にserialize不可能なオブジェクトが存在するなどの理由により、 スナップショットの作成に失敗したことを表す実行じ例外。

クラスから継承されたネストされたクラス/インタフェース java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

インタフェースから継承されたネストされたクラス/インタフェース java.util.Map

java.util.Map.Entry<K,V>

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

コンストラクタ

コンストラクタと説明
CopyOnReadMap() デフォルトコンストラクタ このコンストラクタの処理は以下のソースコードと等価である。
CopyOnReadMap(java.util.Map<K,V> baseMap) 指定されたMapオブジェクトに対する並行アクセスラッパーを作成する。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
CopyOnReadMap<K,V>	deactivate() 同期処理を停止する。
java.util.Map<K,V>	getDelegateMap() このラッパーが処理を委譲するMapオブジェクトを返す。
void	refresh() 現在のスナップショットを破棄する。
CopyOnReadMap<K,V>	save() カレントスレッドが保持しているスナップショットを実体のマップに反映する。
CopyOnReadMap<K,V>	setIgnoredEntries(K... entryNames) 同期処理の対象外とするエントリを追加する。

クラスから継承されたメソッド nablarch.core.util.map.MapWrapper

clear, containsKey, containsValue, entrySet, equals, get, getDelegateMapOfType, hashCode, isEmpty, keySet, put, putAll, remove, size, toString, values

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

clone

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

finalize, getClass, notify, notifyAll, wait, wait, wait

インタフェースから継承されたメソッド java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

コンストラクタの詳細

CopyOnReadMap

public CopyOnReadMap()

デフォルトコンストラクタ

 このコンストラクタの処理は以下のソースコードと等価である。
     new ConcurrentReadMap(new ConcurrentHashMap);
 

CopyOnReadMap

public CopyOnReadMap(java.util.Map<K,V> baseMap)

指定されたMapオブジェクトに対する並行アクセスラッパーを作成する。

パラメータ:

baseMap - ラップ対象のMap

メソッドの詳細

getDelegateMap

public java.util.Map<K,V> getDelegateMap()
                                  throws CopyOnReadMap.SnapshotCreationError

このラッパーが処理を委譲するMapオブジェクトを返す。 本クラスの実装では、変更点を一時的に保持するためのスナップショットが返される。 スナップショットに対する変更はsave()で明示的に反映させる必要がある。

定義:

getDelegateMap クラス内 MapWrapper<K,V>

戻り値:

処理を委譲するMapオブジェクト

例外:

CopyOnReadMap.SnapshotCreationError - セッション内にserialize不可能なオブジェクトが存在するなどの理由で、 セッションのスナップショットの作成に失敗した場合。

deactivate

public CopyOnReadMap<K,V> deactivate()

同期処理を停止する。 以降はベースとなるMapに単に処理を委譲するのみ。

戻り値:

このオブジェクト自体。

setIgnoredEntries

public CopyOnReadMap<K,V> setIgnoredEntries(K... entryNames)

同期処理の対象外とするエントリを追加する。

パラメータ:

entryNames - 同期処理の対象外とするエントリのキー名

戻り値:

このオブジェクト自体

save

public CopyOnReadMap<K,V> save()
                        throws java.util.ConcurrentModificationException,
                               CopyOnReadMap.SnapshotCreationError

カレントスレッドが保持しているスナップショットを実体のマップに反映する。 処理の結果によらず、現行スレッドのスナップショットは破棄する。

戻り値:

このオブジェクト自体。

例外:

java.util.ConcurrentModificationException - スナップショットを作成してからこれまでの間に、 カレントスレッド以外によるアクセスがあった場合。

CopyOnReadMap.SnapshotCreationError - セッション内にserialize不可能なオブジェクトが存在するなどの理由で、 セッションのスナップショットの作成に失敗した場合。

refresh

public void refresh()

現在のスナップショットを破棄する。