18.2.9　Groupインタフェース

(a)　機能

グループ名を取得します。

(b)　形式

public String toString()

(c)　戻り値

グループ名が返却されます。

(a)　機能

指定したオブジェクトが同一のグループを示すGroupインスタンスかどうかを判定します。

(b)　形式

public boolean equals(Object obj)

(c)　パラメータ

obj

比較対象のオブジェクトを指定します。

(d)　戻り値

true

指定したオブジェクトは，同一のグループを示すGroupインスタンスです。

false

指定したオブジェクトは，同一のグループを示すGroupインスタンスではありません。

(a)　機能

グループに対応するポジション（ハッシュ値）を取得します。

(b)　形式

public int getPosition()
                throws EADsStoreException

(c)　戻り値

グループに対応するポジション（ハッシュ値）が返却されます。

(d)　発生する例外

• UserOperationException（ユーザの操作不正）

• EADsStoreException（予期しないエラー）

(a)　機能

指定したグループに属するkeyを生成します。

(b)　形式

public Key createKey(String element)
              throws EADsStoreException

(c)　パラメータ

element

グループ名に連結する要素名を指定します。

次の場合は不正となります。

• 要素名を連結したあとのkeyが，「15.2.2(1)　keyとして指定できるデータ」に示す条件を満たさない場合

• コロン（:）を含む場合

(d)　戻り値

Keyインスタンスが返却されます。

(e)　発生する例外

• UserOperationException（ユーザの操作不正）

• EADsStoreException（予期しないエラー）

(a)　機能

指定したグループの直下の階層のグループを生成します。

(b)　形式

public Group createGroup(String groupLayerName)
                  throws EADsStoreException

(c)　パラメータ

groupLayerName

グループの階層名を指定します。

次の場合は不正となります。

• グループの階層名を連結したあとのグループ名が，「15.2.2(1)　keyとして指定できるデータ」に示す条件を満たさない場合

• コロン（:）を含む場合

(d)　戻り値

指定したグループにアクセスするためのインスタンスが返却されます。

(e)　発生する例外

• UserOperationException（ユーザの操作不正）

• EADsStoreException（予期しないエラー）

(a)　機能

指定したグループに属する格納済みのkeyのうち，ASCIIコード順で先頭となるkeyを取得します。

(b)　形式

public Key firstKey()
             throws EADsStoreException

(c)　戻り値

指定したグループに属する格納済みのkeyのうち，ASCIIコード順で先頭となるkeyが返却されます。

指定したグループに属するkeyが存在しない場合は，nullが返却されます。

(d)　発生する例外

• InternalServerException（EADSサーバの内部エラー）

• EADsStoreException（予期しないエラー）

(a)　機能

指定したグループに属する格納済みのkeyのうち，ASCIIコード順で末尾となるkeyを取得します。

(b)　形式

public Key lastKey()
            throws EADsStoreException

(c)　戻り値

指定したグループに属する格納済みのkeyのうち，ASCIIコード順で末尾となるkeyが返却されます。

指定したグループに属するkeyが存在しない場合は，nullが返却されます。

(d)　発生する例外

• InternalServerException（EADSサーバの内部エラー）

• EADsStoreException（予期しないエラー）

(a)　機能

指定したグループに属するkeyに，ASCIIコードの昇順でアクセスする反復子を取得します。

反復子の開始位置は，グループの先頭のkeyとなります。

(b)　形式

public java.util.Iterator<Key> keyIterator() 
                                    throws EADsStoreException

(c)　戻り値

グループに属するkeyに，ASCIIコードの昇順でアクセスする反復子が返却されます。

(d)　発生する例外

• EADsStoreException（予期しないエラー）

(e)　注意事項

タイミングによっては，反復子で取得したkeyに関連づけられたvalueが，削除されている場合があります。

(a)　機能

指定したグループに属するkeyに，ASCIIコードの昇順でアクセスする反復子を取得します。

反復子の開始位置は，グループに属するkeyのうち，ASCIIコードの昇順で，指定したkeyの次に位置するkeyとなります。

(b)　形式

public java.util.Iterator<Key> keyIterator(Key previousKey)
                                    throws EADsStoreException

(c)　パラメータ

previousKey

反復子の開始位置を示す直前のkeyを指定します。

次の場合は不正となります。

• nullの場合

• 不正なKeyインタフェースのオブジェクトの場合

(d)　戻り値

指定したグループに属するkeyに，ASCIIコードの昇順でアクセスする反復子が返却されます。

(e)　発生する例外

• UserOperationException（ユーザの操作不正）

• EADsStoreException（予期しないエラー）

(f)　注意事項

タイミングによっては，反復子で取得したkeyに関連づけられたvalueが，削除されていることがあります。

(a)　機能

指定したグループに属するkeyに，ASCIIコードの降順でアクセスする反復子を取得します。

反復子の開始位置は，グループの末尾のkeyとなります。

(b)　形式

public java.util.Iterator<Key> descendingKeyIterator()
                                              throws EADsStoreException

(c)　戻り値

グループに属するkeyに，ASCIIコードの降順でアクセスする反復子が返却されます。

(d)　発生する例外

• EADsStoreException（予期しないエラー）

(e)　注意事項

タイミングによっては，反復子で取得したkeyに関連づけられたvalueが，削除されている場合があります。

(a)　機能

指定したグループに属するkeyに，ASCIIコードの降順でアクセスする反復子を取得します。

反復子の開始位置は，グループに属するkeyのうち，ASCIIコードの降順で，指定したkeyの次に位置するkeyとなります。

(b)　形式

public java.util.Iterator<Key> descendingKeyIterator(Key previousKey)
                                              throws EADsStoreException

(c)　パラメータ

previousKey

反復子の開始位置を示す直前のkeyを指定します。

次の場合は不正となります。

• nullの場合

• 不正なKeyインタフェースのオブジェクトの場合

(d)　戻り値

指定したグループに属するkeyに，ASCIIコードの降順でアクセスする反復子が返却されます。

(e)　発生する例外

• UserOperationException（ユーザの操作不正）

• EADsStoreException（予期しないエラー）

(f)　注意事項

タイミングによっては，反復子で取得したkeyに関連づけられたvalueが，削除されている場合があります。

(a)　機能

指定したグループに属するkeyに，ASCIIコードの昇順でアクセスする反復子を取得します。

反復子の開始位置は，ASCIIコードの昇順で，指定されたkeyの次に位置するkeyとなります。

(b)　形式

public java.util.Iterator<Key> higherKeyIterator(java.lang.String key)
                                          throws EADsStoreException

(c)　パラメータ

key

keyを指定します。

指定できるデータについては，「15.2.2(1)　keyとして指定できるデータ」を参照してください。

(d)　戻り値

グループに属するkeyに，ASCIIコードの昇順でアクセスする反復子が返却されます。

(e)　発生する例外

• UserOperationException（ユーザの操作不正）

• EADsStoreException（予期しないエラー）

(f)　注意事項

タイミングによっては，反復子で取得したkeyに関連づけられたvalueが，削除されている場合があります。

(a)　機能

指定したグループに属するkeyに，ASCIIコードの降順でアクセスする反復子を取得します。

反復子の開始位置は，ASCIIコードの降順で，指定されたkeyの次に位置するkeyとなります。

(b)　形式

public java.util.Iterator<Key> lowerDescendingKeyIterator(java.lang.String key)
                                         throws EADsStoreException

(c)　パラメータ

key

keyを指定します。

指定できるデータについては，「15.2.2(1)　keyとして指定できるデータ」を参照してください。

(d)　戻り値

グループに属するkeyに，ASCIIコードの降順でアクセスする反復子が返却されます。

(e)　発生する例外

• UserOperationException（ユーザの操作不正）

• EADsStoreException（予期しないエラー）

(f)　注意事項

タイミングによっては，反復子で取得したkeyに関連づけられたvalueが，削除されている場合があります。

(a)　機能

valueをkeyに関連づけて格納します。

valueの格納で問題が発生した場合は，EADsStoreExceptionが返却されます。

データ自動削除機能を使用している場合，key数がしきい値の上限に達しているときは，データの削除ポリシーに従ってデータを削除してから，valueをkeyに関連付けて格納します。既存のデータを更新する場合もデータは削除されます。

データ自動削除機能でデータの削除に失敗した場合，valueの格納を実行しないでremoveが失敗したときの例外が返却されます。

(b)　形式

public void put(java.lang.String key,
                java.lang.Object value)
         throws EADsStoreException

(c)　パラメータ

key

valueに関連づけるkeyを指定します。

指定できるデータについては，「15.2.2(1)　keyとして指定できるデータ」を参照してください。

value

格納するvalueを指定します。

指定できるデータについては，「15.2.2(3)　valueとして指定できるデータ」を参照してください。

(d)　発生する例外

• UserOperationException（ユーザの操作不正）

• InternalServerException（EADSサーバの内部エラー）

• EADsStoreException（予期しないエラー）

(a)　機能

valueをkeyに関連づけて格納します。

valueの格納で問題が発生した場合は，EADsStoreExceptionが返却されます。

データ自動削除機能を使用している場合，key数がしきい値の上限に達しているときは，データの削除ポリシーに従ってデータを削除してから，valueをkeyに関連付けて格納します。既存のデータを更新する場合もデータは削除されます。

データ自動削除機能でデータの削除に失敗した場合，valueの格納を実行しないでremoveが失敗したときの例外が返却されます。

(b)　形式

public void put(Key key,
                java.lang.Object value)
         throws EADsStoreException

(c)　パラメータ

key

valueに関連づけるKeyインタフェースのkeyを指定します。

次の場合は不正となります。

• nullの場合

• 不正なKeyインタフェースのオブジェクトの場合

value

格納するvalueを指定します。

指定できるデータについては，「15.2.2(3)　valueとして指定できるデータ」を参照してください。

(d)　発生する例外

• UserOperationException（ユーザの操作不正）

• InternalServerException（EADSサーバの内部エラー）

• EADsStoreException（予期しないエラー）

(a)　機能

新規にkeyを格納する場合だけ，valueをkeyに関連づけて格納します。

valueの格納で問題が発生した場合は，EADsStoreExceptionが返却されます。

データ自動削除機能を使用している場合，key数がしきい値の上限に達しているときは，データの削除ポリシーに従ってデータを削除してから，valueをkeyに関連付けて格納します。データの削除はすでにvalueがある場合も実行されます。

データ自動削除機能でデータの削除に失敗した場合，valueの格納を実行しないでremoveが失敗したときの例外が返却されます。

(b)　形式

public void create(java.lang.String key,
                   java.lang.Object value)
            throws EADsStoreException

(c)　パラメータ

key

valueに関連づけるkeyを指定します。

指定できるデータについては，「15.2.2(1)　keyとして指定できるデータ」を参照してください。

value

格納するvalueを指定します。

指定できるデータについては，「15.2.2(3)　valueとして指定できるデータ」を参照してください。

(d)　発生する例外

• UserOperationException（ユーザの操作不正）

• InternalServerException（EADSサーバの内部エラー）

• EADsStoreException（予期しないエラー）

(a)　機能

指定したkeyがすでに格納されている場合だけ，valueをkeyに関連づけて格納します（valueを更新します）。

valueの格納で問題が発生した場合は，EADsStoreExceptionが返却されます。

(b)　形式

public void update(java.lang.String key,
                   java.lang.Object value)
            throws EADsStoreException

(c)　パラメータ

key

valueに関連づけるkeyを指定します。

指定できるデータについては，「15.2.2(1)　keyとして指定できるデータ」を参照してください。

value

格納するvalueを指定します。

指定できるデータについては，「15.2.2(3)　valueとして指定できるデータ」を参照してください。

(d)　発生する例外

• UserOperationException（ユーザの操作不正）

• InternalServerException（EADSサーバの内部エラー）

• EADsStoreException（予期しないエラー）

(a)　機能

指定したkeyがすでに格納されている場合だけ，valueをkeyに関連づけて格納します（valueを更新します）。

valueの格納で問題が発生した場合は，EADsStoreExceptionが返却されます。

(b)　形式

public void update(Key key,
                   java.lang.Object value)
            throws EADsStoreException

(c)　パラメータ

key

valueに関連づけるKeyインタフェースのkeyを指定します。

次の場合は不正となります。

• nullの場合

• 不正なKeyインタフェースのオブジェクトの場合

value

格納するvalueを指定します。

指定できるデータについては，「15.2.2(3)　valueとして指定できるデータ」を参照してください。

(d)　発生する例外

• UserOperationException（ユーザの操作不正）

• InternalServerException（EADSサーバの内部エラー）

• EADsStoreException（予期しないエラー）

(a)　機能

指定したkeyに関連づけられているvalueを，条件として指定したvalue（comparativeValue）と比較します。valueが一致している場合だけ，valueをkeyに関連づけて格納します（valueを置換します）。

valueの置き換えで問題が発生した場合は，EADsStoreExceptionが返却されます。

(b)　形式

public void replace(java.lang.String key,
                    java.lang.Object value,
                    java.lang.Object comparativeValue)
             throws EADsStoreException

(c)　パラメータ

key

置き換えるvalueに関連づけられたkeyを指定します。

指定できるデータについては，「15.2.2(1)　keyとして指定できるデータ」を参照してください。

value

格納するvalueを指定します。

指定できるデータについては，「15.2.2(3)　valueとして指定できるデータ」を参照してください。

comparativeValue

比較するvalueを指定します。

指定できるデータについては，「15.2.2(3)　valueとして指定できるデータ」を参照してください。

(d)　発生する例外

• UserOperationException（ユーザの操作不正）

• InternalServerException（EADSサーバの内部エラー）

• EADsStoreException（予期しないエラー）

(a)　機能

指定したkeyに関連づけられているvalueを，条件として指定したvalue（comparativeValue）と比較します。valueが一致している場合だけ，valueをkeyに関連づけて格納します（valueを置換します）。

valueの置き換えで問題が発生した場合は，EADsStoreExceptionが返却されます。

(b)　形式

public void replace(Key key,
                    java.lang.Object value,
                    java.lang.Object comparativeValue)
             throws EADsStoreException

(c)　パラメータ

key

置き換えるvalueに関連づけられたKeyインタフェースのkeyを指定します。

次の場合は不正となります。

• nullの場合

• 不正なKeyインタフェースのオブジェクトの場合

value

格納するvalueを指定します。

指定できるデータについては，「15.2.2(3)　valueとして指定できるデータ」を参照してください。

comparativeValue

比較するvalueを指定します。

指定できるデータについては，「15.2.2(3)　valueとして指定できるデータ」を参照してください。

(d)　発生する例外

• UserOperationException（ユーザの操作不正）

• InternalServerException（EADSサーバの内部エラー）

• EADsStoreException（予期しないエラー）

(a)　機能

指定したkeyに関連づけられたvalueを取得します。

valueの取得で問題が発生した場合は，EADsStoreExceptionが返却されます。

(b)　形式

public java.lang.Object get(java.lang.String key)
                     throws EADsStoreException

(c)　パラメータ

key

取得するvalueに関連づけられたkeyを指定します。

指定できるデータについては，「15.2.2(1)　keyとして指定できるデータ」を参照してください。

(d)　戻り値

keyに関連づけられたvalueが返却されます。

指定したkeyに何も関連づけられていなかった場合は，nullが返却されます。

(e)　発生する例外

• UserOperationException（ユーザの操作不正）

• InternalServerException（EADSサーバの内部エラー）

• EADsStoreException（予期しないエラー）

(a)　機能

指定したkeyに関連づけられたvalueを取得します。

valueの取得で問題が発生した場合は，EADsStoreExceptionが返却されます。

(b)　形式

public java.lang.Object get(Key key)
                     throws EADsStoreException

(c)　パラメータ

key

取得するvalueに関連づけられたKeyインタフェースのkeyを指定します。

次の場合は不正となります。

• nullの場合

• 不正なKeyインタフェースのオブジェクトの場合

(d)　戻り値

keyに関連づけられたvalueが返却されます。

指定したkeyに何も関連づけられていなかった場合は，nullが返却されます。

(e)　発生する例外

• UserOperationException（ユーザの操作不正）

• InternalServerException（EADSサーバの内部エラー）

• EADsStoreException（予期しないエラー）

(a)　機能

指定したkey，およびkeyに関連づけられたvalueを削除します。

valueの削除で問題が発生した場合は，EADsStoreExceptionが返却されます。

(b)　形式

public void remove(java.lang.String key)
            throws EADsStoreException

(c)　パラメータ

key

削除するvalueに関連づけられたkeyを指定します。

指定できるデータについては，「15.2.2(1)　keyとして指定できるデータ」を参照してください。

(d)　発生する例外

• UserOperationException（ユーザの操作不正）

• InternalServerException（EADSサーバの内部エラー）

• EADsStoreException（予期しないエラー）

(a)　機能

指定したkey，およびkeyに関連づけられたvalueを削除します。

valueの削除で問題が発生した場合は，EADsStoreExceptionが返却されます。

(b)　形式

public void remove(Key key)
            throws EADsStoreException

(c)　パラメータ

key

削除するvalueに関連づけられたKeyインタフェースのkeyを指定します。

次の場合は不正となります。

• nullの場合

• 不正なKeyインタフェースのオブジェクトの場合

(d)　発生する例外

• UserOperationException（ユーザの操作不正）

• InternalServerException（EADSサーバの内部エラー）

• EADsStoreException（予期しないエラー）

(a)　機能

指定したkeyに関連づけられたvalueの最終更新時刻を取得します。

(b)　形式

public long getLastUpdateTime(String key)
                       throws EADsStoreException

(c)　パラメータ

key

keyを指定します。

指定できるデータについては，「15.2.2(1)　keyとして指定できるデータ」を参照してください。

(d)　戻り値

データの最終更新時刻（1970年1月1日00:00:00からの通算ミリ秒）が返却されます。

(e)　発生する例外

• UserOperationException（ユーザの操作不正）

• InternalServerException（EADSサーバの内部エラー）

• EADsStoreException（予期しないエラー）

(a)　機能

指定したkeyに関連づけられたvalueの最終更新時刻を取得します。

(b)　形式

public long getLastUpdateTime(Key key)
                       throws EADsStoreException

(c)　パラメータ

key

valueに関連づけられたKeyインタフェースのkeyを指定します。

次の場合は不正となります。

• nullの場合

• 不正なKeyインタフェースのオブジェクトの場合

(d)　戻り値

データの最終更新時刻（1970年1月1日00:00:00からの通算ミリ秒）が返却されます。

(e)　発生する例外

• UserOperationException（ユーザの操作不正）

• InternalServerException（EADSサーバの内部エラー）

• EADsStoreException（予期しないエラー）

(a)　機能

このグループに属するkeyの数を取得します。

(b)　形式

public int getKeyCount()
                throws EADsStoreException

(c)　戻り値

このグループに属するkeyの数が返却されます。

(d)　発生する例外

• InternalServerException（EADSサーバの内部エラー）

• EADsStoreException（予期しないエラー）

(a)　機能

このグループの直下の階層のグループ数を取得します。

(b)　形式

public int getGroupCount()
                  throws EADsStoreException

(c)　戻り値

このグループの直下の階層のグループ数が返却されます。

(d)　発生する例外

• InternalServerException（EADSサーバの内部エラー）

• EADsStoreException（予期しないエラー）

(a)　機能

直下の階層のグループ名の一覧を取得します。

グループ名の一覧は，ASCIIコードの昇順になります。

(b)　形式

public String[] getGroupNames()
                       throws EADsStoreException

(c)　戻り値

直下の階層のグループ名の一覧が返却されます。

(d)　発生する例外

• InternalServerException（EADSサーバの内部エラー）

• EADsStoreException（予期しないエラー）

(a)　機能

直下の階層のグループ階層名の一覧を取得します。

グループ階層名の一覧は，ASCIIコードの昇順になります。

(b)　形式

public String[] getGroupLayerNames()
                            throws EADsStoreException

(c)　戻り値

直下の階層のグループ階層名の一覧が返却されます。

(d)　発生する例外

• InternalServerException（EADSサーバの内部エラー）

• EADsStoreException（予期しないエラー）

(a)　機能

グループ名の一覧をASCIIコードの昇順で取得します。

(b)　形式

public java.util.Set<String> getGroupNameSet()
                            throws EADsStoreException

(c)　戻り値

直下の階層のグループ名の一覧（ASCIIコードの昇順）が返却されます。

(d)　発生する例外

• InternalServerException（EADSサーバの内部エラー）

• EADsStoreException（予期しないエラー）

(a)　機能

指定したkeyに関連づけられたvalueのメモリ使用量を取得します。

(b)　形式

public long getValueUsageSize(String key)
                       throws EADsStoreException

(c)　パラメータ

key

keyを指定します。

指定できるデータについては，「15.2.2(1)　keyとして指定できるデータ」を参照してください。

(d)　戻り値

指定したkeyに関連づけられたvalueのメモリ使用量（単位：バイト）が返却されます。

valueをメモリに格納しないキャッシュの場合は，0が返却されます。

(e)　発生する例外

• UserOperationException（ユーザの操作不正）

• InternalServerException（EADSサーバの内部エラー）

• EADsStoreException（予期しないエラー）

(a)　機能

指定したkeyに関連づけられたvalueのメモリ使用量を取得します。

(b)　形式

public long getValueUsageSize(Key key)
                       throws EADsStoreException

(c)　パラメータ

key

valueに関連づけられたKeyインタフェースのkeyを指定します。

次の場合は不正となります。

• nullの場合

• 不正なKeyインタフェースのオブジェクトの場合

(d)　戻り値

指定したkeyに関連づけられたvalueのメモリ使用量（単位：バイト）が返却されます。

valueをメモリに格納しないキャッシュの場合は，0が返却されます。

(e)　発生する例外

• UserOperationException（ユーザの操作不正）

• InternalServerException（EADSサーバの内部エラー）

• EADsStoreException（予期しないエラー）

(a)　機能

下位のグループも含めて，グループに属する全valueのメモリ使用量の合計を取得します。

(b)　形式

public long getValueUsageSize()
                       throws EADsStoreException

(c)　戻り値

グループに属する全valueのメモリ使用量（単位：バイト）の合計が返却されます。

valueをメモリに格納しないキャッシュの場合は，0が返却されます。

(d)　発生する例外

• InternalServerException（EADSサーバの内部エラー）

• EADsStoreException（予期しないエラー）