18.2.10 Key interface
- Organization of this subsection
(1) Description
This interface represents keys in the API methods that can be used in user functions.
(2) Interface name
com.hitachi.software.xeads.func.store.Key
(3) List of methods
The following table lists and describes the methods provided by the Key interface:
|
Method name |
Description |
|---|---|
|
Acquires a key. |
|
|
Evaluates whether a specified object is a Key instance indicating this key. |
|
|
Acquires the position (hash value) corresponding to this key. |
(4) toString()
(a) Description
This method acquires a key.
(b) Format
public String toString()
(c) Return value
This method returns a key.
(5) equals()
(a) Description
This method evaluates whether a specified object is a Key instance indicating this key.
(b) Format
public boolean equals(Object obj)
(c) Parameters
- obj
-
Specifies the object to be compared.
(d) Return value
- true
-
The specified object is a Key instance indicating this key.
- false
-
The specified object is not a Key instance indicating this key.
(6) getPosition()
(a) Description
This method acquires the position (hash value) corresponding this key.
(b) Format
public int getPosition()
throws EADsStoreException(c) Return value
This method returns the position (hash value) corresponding to this key.
(d) Exceptions
-
UserOperationException (illegal user operation)
-
EADsStoreException (unexpected error)