18.2.11 Valueインタフェース
(1) 説明
ユーザファンクションで使用できるAPI内で，keyに関連づけて格納されるvalueを表現するインタフェースです。
(2) インタフェース名
com.hitachi.software.xeads.func.store.Value
(3) メソッド一覧
Valueインタフェースが提供するメソッド一覧を次の表に示します。
|
メソッド名 |
説明 |
|---|---|
|
String型のvalueを取得します。 |
|
|
指定したオブジェクトが同一のvalueを示すValueインスタンスかどうかを判定します。 |
|
|
Object型のvalueを取得します。 |
|
|
キャッシュに格納する際の内部形式である，シリアライズ後のvalueのサイズを取得します。 |
(4) toString()
(a) 機能
String型のvalueを取得します。
ValueインタフェースのgetObject()で取得するObject型のvalueの，ObjectクラスのtoString()と同じ文字列を取得します。
(b) 形式
public String toString()
(c) 戻り値
String型のvalueが返却されます。
(d) 注意事項
ValueインタフェースのgetObject()がデシリアライズできないで失敗する場合は，ValueインスタンスのObjectクラスのtoString()と同じ戻り値が返却されます。
(5) equals()
(a) 機能
指定したオブジェクトが同一のvalueを示すValueインスタンスかどうかを判定します。
(b) 形式
public boolean equals(Object obj)
(c) パラメータ
- obj
-
比較対象のオブジェクトを指定します。
(d) 戻り値
- true
-
指定したオブジェクトは，同一のvalueを示すValueインスタンスです。
- false
-
指定したオブジェクトは，同一のvalueを示すValueインスタンスではありません。
(e) 注意事項
同一のオブジェクトかどうかは，シリアライズ後のバイト配列が等しいかどうかで判定されます。
(6) getObject()
(a) 機能
Object型のvalueを取得します。
(b) 形式
public Object getObject()
throws EADsStoreException(c) 戻り値
Object型のvalueが返却されます。
(d) 発生する例外
-
UserOperationException（ユーザの操作不正）
-
EADsStoreException（予期しないエラー）
(7) size()
(a) 機能
キャッシュに格納する際の内部形式である，シリアライズ後のvalueのサイズを取得します。
(b) 形式
public int size()
(c) 戻り値
キャッシュに格納する際の内部形式である，シリアライズ後のvalueのサイズ（単位：バイト）が返却されます。
(d) 注意事項
このメソッドで返却されるサイズは，valueを格納する際にvalueだけが使用する領域のサイズです。
valueを格納する際は，value以外のデータも領域を使用する場合があります。そのため，valueの格納で使用される領域サイズを計算したい場合は，次のAPIを使用してください。
-
StoreインタフェースのcalcEHeapUsageSize()
-
StoreインタフェースのcalcDiskUsageSize()