18.2.9 Group interface

(a) Description

This method acquires the group name.

(b) Format

public String toString()

(c) Return value

This method returns the group name.

(a) Description

This method evaluates whether a specified object is the Group instance indicating this group.

(b) Format

public boolean equals(Object obj)

(c) Parameters

obj

Specifies the object to be compared.

(d) Return value

true

The specified object is the Group instance indicating this group.

false

The specified object is not the Group instance indicating this group.

(a) Description

This method acquires the position (hash group) that corresponds to the group.

(b) Format

public int getPosition()
                throws EADsStoreException

(c) Return value

This method returns the position (hash group) that corresponds to the group.

(d) Exceptions

• UserOperationException (illegal user operation)

• EADsStoreException (unexpected error)

(a) Description

This method creates a key that is to belong to this group.

(b) Format

public Key createKey(String element)
              throws EADsStoreException

(c) Parameters

element

Specifies an element name to be concatenated with the group name.

This parameter is invalid in the following cases:

• A key with the element name concatenated does not satisfy the conditions explained in 15.2.2(1) Data types that can be specified as keys.

• The name contains a colon (:).

(d) Return value

This method returns a Key instance.

(e) Exceptions

• UserOperationException (illegal user operation)

• EADsStoreException (unexpected error)

(a) Description

This method creates a hierarchy group immediately below the specified group.

(b) Format

public Group createGroup(String groupLayerName)
                  throws EADsStoreException

(c) Parameters

groupLayerName

Specifies a group hierarchy name.

This parameter is invalid in the following cases:

• A group name with this group hierarchy name concatenated does not satisfy the conditions explained in 15.2.2(1) Data types that can be specified as keys.

• The name contains a colon (:).

(d) Return value

This method returns the instance needed for accessing the specified group.

(e) Exceptions

• UserOperationException (illegal user operation)

• EADsStoreException (unexpected error)

(a) Description

This method acquires the first key in order of ASCII codes of all the keys that are stored and belong to the specified group.

(b) Format

public Key firstKey()
             throws EADsStoreException

(c) Return value

This method returns the first key in order of ASCII codes of all the keys that are stored and belong to the specified group.

If no keys belong to the specified group, the method returns null.

(d) Exceptions

• InternalServerException (EADS server internal error)

• EADsStoreException (unexpected error)

(a) Description

This method acquires the last key in order of ASCII codes of all the keys that are stored and belong to the specified group.

(b) Format

public Key lastKey()
            throws EADsStoreException

(c) Return value

This method returns the last key in order of ASCII codes of all the keys that are stored and belong to the specified group.

If no keys belong to the specified group, the method returns null.

(d) Exceptions

• InternalServerException (EADS server internal error)

• EADsStoreException (unexpected error)

(a) Description

This method acquires an iterator that accesses the keys belonging to the specified group in ascending order based on their ASCII code values.

The start position of the iterator is the first key in the group.

(b) Format

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

(c) Return value

This method returns an iterator that accesses the keys belonging to the group in ascending order based on their ASCII code values.

(d) Exceptions

• EADsStoreException (unexpected error)

(e) Notes

Depending on the timing, the value associated with a key obtained by the iterator might have been deleted.

(a) Description

This method acquires an iterator that accesses the keys belonging to the specified group in ascending order based on their ASCII code values.

The start position of the iterator is the key immediately following a specified key in ascending order based on its ASCII code value of all the keys that belong to the group.

(b) Format

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

(c) Parameters

previousKey

Specifies the immediately preceding key that indicates the start position of the iterator.

This parameter is invalid in the following cases:

• null is specified.

• The specified object of the Key interface is invalid.

(d) Return value

This method returns an iterator that accesses the keys belonging to the specified group in ascending order based on their ASCII code values.

(e) Exceptions

• UserOperationException (illegal user operation)

• EADsStoreException (unexpected error)

(f) Notes

Depending on the timing, the value associated with a key obtained by the iterator might have been deleted.

(a) Description

This method acquires an iterator that accesses the keys belonging to the specified group in descending order based on their ASCII code values.

The start position of the iterator is the last key in the group.

(b) Format

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

(c) Return value

This method returns an iterator that accesses the keys belonging to the group in descending order based on their ASCII code values.

(d) Exceptions

• EADsStoreException (unexpected error)

(e) Notes

Depending on the timing, the value associated with a key obtained by the iterator might have been deleted.

(a) Description

This method acquires an iterator that accesses the keys belonging to the specified group in descending order based on their ASCII code values.

The start position of the iterator is the key immediately following a specified key in descending order based on its ASCII code value of all the keys that belong to the group.

(b) Format

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

(c) Parameters

previousKey

Specifies the immediately preceding key that indicates the start position of the iterator.

This parameter is invalid in the following cases:

• null is specified.

• The specified object of the Key interface is invalid.

(d) Return value

This method returns an iterator that accesses the keys belonging to the specified group in descending order based on their ASCII code values.

(e) Exceptions

• UserOperationException (illegal user operation)

• EADsStoreException (unexpected error)

(f) Notes

Depending on the timing, the value associated with a key obtained by the iterator might have been deleted.

(a) Description

This method acquires an iterator that accesses the keys belonging to the specified group in ascending order based on their ASCII code values.

The start position of the iterator is the key that immediately follows a specified key in ascending order based on its ASCII code value.

(b) Format

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

(c) Parameters

key

Specifies a key.

For details about the data types that can be specified, see 15.2.2(1) Data types that can be specified as keys.

(d) Return value

This method returns an iterator that accesses the keys belonging to the group in ascending order based on their ASCII code values.

(e) Exceptions

• UserOperationException (illegal user operation)

• EADsStoreException (unexpected error)

(f) Notes

Depending on the timing, the value associated with a key obtained by the iterator might have been deleted.

(a) Description

This method acquires an iterator that accesses the keys belonging to the specified group in descending order based on their ASCII code values.

The start position of the iterator is the key that immediately follows a specified key in descending order based on its ASCII code value.

(b) Format

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

(c) Parameters

key

Specifies a key.

For details about the data types that can be specified, see 15.2.2(1) Data types that can be specified as keys.

(d) Return value

This method returns an iterator that accesses the keys belonging to the group in descending order based on their ASCII code values.

(e) Exceptions

• UserOperationException (illegal user operation)

• EADsStoreException (unexpected error)

(f) Notes

Depending on the timing, the value associated with a key obtained by the iterator might have been deleted.

(a) Description

This method associates a value with a key, and then stores it.

If a problem occurs when the value is stored, the method returns EADsStoreException.

(b) Format

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

(c) Parameters

key

Specifies a key to be associated with the value.

For details about the data types that can be specified, see 15.2.2(1) Data types that can be specified as keys.

value

Specifies the value to be stored.

For details about the data types that can be specified, see 15.2.2(3) Data types that can be specified as values.

(d) Exceptions

• UserOperationException (illegal user operation)

• InternalServerException (EADS server internal error)

• EADsStoreException (unexpected error)

(a) Description

This method associates a value with a key, and then stores it.

If a problem occurs when the value is stored, the method returns EADsStoreException.

(b) Format

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

(c) Parameters

key

Specifies a key of the Key interface that is to be associated with the value.

This parameter is invalid in the following cases:

• null is specified.

• The specified object of the Key interface is invalid.

value

Specifies the value to be stored.

For details about the data types that can be specified, see 15.2.2(3) Data types that can be specified as values.

(d) Exceptions

• UserOperationException (illegal user operation)

• InternalServerException (EADS server internal error)

• EADsStoreException (unexpected error)

(a) Description

This method associates a value with a key, and then stores it only if a new key is stored.

If a problem occurs when the value is stored, the method returns EADsStoreException.

(b) Format

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

(c) Parameters

key

Specifies a key to be associated with the value.

For details about the data types that can be specified, see 15.2.2(1) Data types that can be specified as keys.

value

Specifies the value to be stored.

For details about the data types that can be specified, see 15.2.2(3) Data types that can be specified as values.

(d) Exceptions

• UserOperationException (illegal user operation)

• InternalServerException (EADS server internal error)

• EADsStoreException (unexpected error)

(a) Description

This method associates a value with a key, and then stores it only if a specified key has already been stored (updates the value).

If a problem occurs when the value is stored, the method returns EADsStoreException.

(b) Format

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

(c) Parameters

key

Specifies a key to be associated with the value.

For details about the data types that can be specified, see 15.2.2(1) Data types that can be specified as keys.

value

Specifies the value to be stored.

For details about the data types that can be specified, see 15.2.2(3) Data types that can be specified as values.

(d) Exceptions

• UserOperationException (illegal user operation)

• InternalServerException (EADS server internal error)

• EADsStoreException (unexpected error)

(a) Description

This method associates a value with a key, and then stores it only if a specified key has already been stored (updates the value).

If a problem occurs when the value is stored, the method returns EADsStoreException.

(b) Format

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

(c) Parameters

key

Specifies a key of the Key interface that is to be associated with the value.

This parameter is invalid in the following cases:

• null is specified.

• The specified object of the Key interface is invalid.

value

Specifies the value to be stored.

For details about the data types that can be specified, see 15.2.2(3) Data types that can be specified as values.

(d) Exceptions

• UserOperationException (illegal user operation)

• InternalServerException (EADS server internal error)

• EADsStoreException (unexpected error)

(a) Description

This method compares the value associated with a specified key with a value (comparativeValue) specified as a condition. Only if the values match, this method associates the value with the key, and then stores it (replaces the value).

If a problem occurs when the value is replaced, the method returns EADsStoreException.

(b) Format

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

(c) Parameters

key

Specifies a key that is associated with the value to be replaced.

For details about the data types that can be specified, see 15.2.2(1) Data types that can be specified as keys.

value

Specifies the value to be stored.

For details about the data types that can be specified, see 15.2.2(3) Data types that can be specified as values.

comparativeValue

Specifies the value to be compared.

For details about the data types that can be specified, see 15.2.2(3) Data types that can be specified as values.

(d) Exceptions

• UserOperationException (illegal user operation)

• InternalServerException (EADS server internal error)

• EADsStoreException (unexpected error)

(a) Description

This method compares the value associated with a specified key with a value (comparativeValue) specified as a condition. Only if the values match, this method associates the value with the key, and then stores it (replaces the value).

If a problem occurs when the value is replaced, the method returns EADsStoreException.

(b) Format

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

(c) Parameters

key

Specifies a key of the Key interface that is associated with the value to be replaced.

This parameter is invalid in the following cases:

• null is specified.

• The specified object of the Key interface is invalid.

value

Specifies the value to be stored.

For details about the data types that can be specified, see 15.2.2(3) Data types that can be specified as values.

comparativeValue

Specifies the value to be compared.

For details about the data types that can be specified, see 15.2.2(3) Data types that can be specified as values.

(d) Exceptions

• UserOperationException (illegal user operation)

• InternalServerException (EADS server internal error)

• EADsStoreException (unexpected error)

(a) Description

This method acquires the value associated with a specified key.

If a problem occurs when the value is acquired, the method returns EADsStoreException.

(b) Format

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

(c) Parameters

key

Specifies a key that is associated with the value to be acquired.

For details about the data types that can be specified, see 15.2.2(1) Data types that can be specified as keys.

(d) Return value

This method returns the value associated with the key.

If nothing is associated with the specified key, it returns null.

(e) Exceptions

• UserOperationException (illegal user operation)

• InternalServerException (EADS server internal error)

• EADsStoreException (unexpected error)

(a) Description

This method acquires the value associated with a specified key.

If a problem occurs when the value is acquired, the method returns EADsStoreException.

(b) Format

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

(c) Parameters

key

Specifies a key of the Key interface that is associated with the value to be acquired.

This parameter is invalid in the following cases:

• null is specified.

• The specified object of the Key interface is invalid.

(d) Return value

This method returns the value associated with the key.

If nothing is associated with the specified key, it returns null.

(e) Exceptions

• UserOperationException (illegal user operation)

• InternalServerException (EADS server internal error)

• EADsStoreException (unexpected error)

(a) Description

This method deletes a specified key and the value associated with that key.

If a problem occurs when the value is deleted, the method returns EADsStoreException.

(b) Format

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

(c) Parameters

key

Specifies a key that is associated with the value to be deleted.

For details about the data types that can be specified, see 15.2.2(1) Data types that can be specified as keys.

(d) Exceptions

• UserOperationException (illegal user operation)

• InternalServerException (EADS server internal error)

• EADsStoreException (unexpected error)

(a) Description

This method deletes a specified key and the value associated with that key.

If a problem occurs when the value is deleted, the method returns EADsStoreException.

(b) Format

public void remove(Key key)
            throws EADsStoreException

(c) Parameters

key

Specifies a key of the Key interface that is associated with the value to be deleted.

This parameter is invalid in the following cases:

• null is specified.

• The specified object of the Key interface is invalid.

(d) Exceptions

• UserOperationException (illegal user operation)

• InternalServerException (EADS server internal error)

• EADsStoreException (unexpected error)

(a) Description

This method acquires the last update time of the value associated with a specified key.

(b) Format

public long getLastUpdateTime(String key)
                       throws EADsStoreException

(c) Parameters

key

Specifies a key.

For details about the data types that can be specified, see 15.2.2(1) Data types that can be specified as keys.

(d) Return value

This method returns the last data update time (absolute time in milliseconds from 1970-01-01 at 00:00:00).

(e) Exceptions

• UserOperationException (illegal user operation)

• InternalServerException (EADS server internal error)

• EADsStoreException (unexpected error)

(a) Description

This method acquires the last update time of the value associated with a specified key.

(b) Format

public long getLastUpdateTime(Key key)
                       throws EADsStoreException

(c) Parameters

key

Specifies a key of the Key interface that is associated with the value.

This parameter is invalid in the following cases:

• null is specified.

• The specified object of the Key interface is invalid.

(d) Return value

This method returns the last data update time (absolute time in milliseconds from 1970-01-01 at 00:00:00).

(e) Exceptions

• UserOperationException (illegal user operation)

• InternalServerException (EADS server internal error)

• EADsStoreException (unexpected error)

(a) Description

This method acquires the number of keys that belong to this group.

(b) Format

public int getKeyCount()
                throws EADsStoreException

(c) Return value

This method returns the number of keys that belong to this group.

(d) Exceptions

• InternalServerException (EADS server internal error)

• EADsStoreException (unexpected error)

(a) Description

This method acquires the number of groups in the hierarchy immediately below this group.

(b) Format

public int getGroupCount()
                  throws EADsStoreException

(c) Return value

This method returns the number of groups in the hierarchy immediately below this group.

(d) Exceptions

• InternalServerException (EADS server internal error)

• EADsStoreException (unexpected error)

(a) Description

This method acquires a list of group names in the hierarchy immediately below this group.

The group names are listed in ascending order based on their ASCII code values.

(b) Format

public String[] getGroupNames()
                       throws EADsStoreException

(c) Return value

This method returns a list of group names in the hierarchy immediately below this group.

(d) Exceptions

• InternalServerException (EADS server internal error)

• EADsStoreException (unexpected error)

(a) Description

This method acquires a list of group hierarchy names in the hierarchy immediately below this group.

The group hierarchy names are listed in ascending order based on their ASCII code values.

(b) Format

public String[] getGroupLayerNames()
                            throws EADsStoreException

(c) Return value

This method returns a list of group hierarchy names in the hierarchy immediately below this group.

(d) Exceptions

• InternalServerException (EADS server internal error)

• EADsStoreException (unexpected error)

(a) Description

This method acquires a list of group names in ascending order based on their ASCII code values.

(b) Format

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

(c) Return value

This method returns a list of group names in the hierarchy immediately below (in ascending order based on their ASCII code values).

(d) Exceptions

• InternalServerException (EADS server internal error)

• EADsStoreException (unexpected error)

(a) Description

This method acquires the size of the memory usage for the value associated with a specified key.

(b) Format

public long getValueUsageSize(String key)
                       throws EADsStoreException

(c) Parameters

key

Specifies a key.

For details about the data types that can be specified, see 15.2.2(1) Data types that can be specified as keys.

(d) Return value

This method returns the size of the memory usage (bytes) for the value associated with the specified key.

If the cache does not store values, the method returns 0.

(e) Exceptions

• UserOperationException (illegal user operation)

• InternalServerException (EADS server internal error)

• EADsStoreException (unexpected error)

(a) Description

This method acquires the size of the memory usage for the value associated with a specified key.

(b) Format

public long getValueUsageSize(Key key)
                       throws EADsStoreException

(c) Parameters

key

Specifies a key of the Key interface that is associated with the value.

This parameter is invalid in the following cases:

• null is specified.

• The specified object of the Key interface is invalid.

(d) Return value

This method returns the size of the memory usage (bytes) for the value associated with the specified key.

If the cache does not store values, the method returns 0.

(e) Exceptions

• UserOperationException (illegal user operation)

• InternalServerException (EADS server internal error)

• EADsStoreException (unexpected error)

(a) Description

This method acquires the total size of the memory usage for all values belonging to the group including the groups in the lower hierarchies.

(b) Format

public long getValueUsageSize()
                       throws EADsStoreException

(c) Return value

This method returns the total size (bytes) of the memory usage for all values belonging to the group.

If the cache does not store values, the method returns 0.

(d) Exceptions

• InternalServerException (EADS server internal error)

• EADsStoreException (unexpected error)