public interface UserDataContainer
extends java.lang.Cloneable
UserData
. All graphs,
vertices, and edges implement this interface and can therefore store custom
local data.Modifier and Type | Interface and Description |
---|---|
static interface |
UserDataContainer.CopyAction
Decides what to do when a user datum is copied.
|
Modifier and Type | Method and Description |
---|---|
void |
addUserDatum(java.lang.Object key,
java.lang.Object datum,
UserDataContainer.CopyAction copyAct)
Adds the specified data with the specified key to this object's
user data repository, with the specified CopyAction.
|
java.lang.Object |
clone() |
boolean |
containsUserDatumKey(java.lang.Object key)
Reports whether
key is a key of this user data container. |
java.lang.Object |
getUserDatum(java.lang.Object key)
Retrieves the object in this object's user data repository to which key
refers.
|
UserDataContainer.CopyAction |
getUserDatumCopyAction(java.lang.Object key)
Retrieves the CopyAction for the object stored in this object's
user data repository to which key refers.
|
java.util.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.
|
java.lang.Object |
removeUserDatum(java.lang.Object key)
Retrieves the object in this object's user data repository to which key
refers, and removes it from the repository.
|
void |
setUserDatum(java.lang.Object key,
java.lang.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.
|
java.lang.Object clone() throws java.lang.CloneNotSupportedException
java.lang.CloneNotSupportedException
void addUserDatum(java.lang.Object key, java.lang.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 containerjava.util.Iterator getUserDatumKeyIterator()
UserDataContainer.CopyAction getUserDatumCopyAction(java.lang.Object key)
key
- the key of the datum whose CopyAction is requestedjava.lang.Object getUserDatum(java.lang.Object key)
key
- the key of the datum to retrievevoid setUserDatum(java.lang.Object key, java.lang.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) pairjava.lang.Object removeUserDatum(java.lang.Object key)
key
- the key of the datum to be removedboolean containsUserDatumKey(java.lang.Object key)
key
is a key of this user data container.key
- the key to be queriedkey
is present in this user data container