|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface UserDataContainer
The generic interface for storing UserData
. All graphs,
vertices, and edges implement this interface and can therefore store custom
local data.
Nested Class Summary | |
---|---|
static interface |
UserDataContainer.CopyAction
Decides what to do when a user datum is copied. |
Method Summary | |
---|---|
void |
addUserDatum(Object key,
Object datum,
UserDataContainer.CopyAction copyAct)
Adds the specified data with the specified key to this object's user data repository, with the specified CopyAction. |
Object |
clone()
|
boolean |
containsUserDatumKey(Object key)
Reports whether key is a key of this user data container. |
Object |
getUserDatum(Object key)
Retrieves the object in this object's user data repository to which key refers. |
UserDataContainer.CopyAction |
getUserDatumCopyAction(Object key)
Retrieves the CopyAction for the object stored in this object's user data repository to which key refers. |
Iterator |
getUserDatumKeyIterator()
Provides an iterator over this object's user data repository key set. |
void |
importUserData(UserDataContainer udc)
Takes the user data stored in udc and copies it to this object's user data repository, respecting each datum's CopyAction. |
Object |
removeUserDatum(Object key)
Retrieves the object in this object's user data repository to which key refers, and removes it from the repository. |
void |
setUserDatum(Object key,
Object datum,
UserDataContainer.CopyAction copyAct)
If key refers to an existing user datum in this object's repository, that datum is replaced by the specified datum. |
Method Detail |
---|
Object clone() throws CloneNotSupportedException
CloneNotSupportedException
void addUserDatum(Object key, Object datum, UserDataContainer.CopyAction copyAct)
key
- the key of the datum being addeddatum
- the datum being addedcopyAct
- the CopyAction of the datum being addedvoid importUserData(UserDataContainer udc)
udc
- the source of the user data to be copied into this containerIterator getUserDatumKeyIterator()
UserDataContainer.CopyAction getUserDatumCopyAction(Object key)
key
- the key of the datum whose CopyAction is requested
Object getUserDatum(Object key)
key
- the key of the datum to retrieve
void setUserDatum(Object key, Object datum, UserDataContainer.CopyAction copyAct)
key
- the key of the datum being added/modifieddatum
- the replacement/new datumcopyAct
- the CopyAction for the new (key, datum) pairObject removeUserDatum(Object key)
key
- the key of the datum to be removed
boolean containsUserDatumKey(Object key)
key
is a key of this user data container.
key
- the key to be queried
key
is present in this user data container
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |