public interface UserDataHandler
When associating an object to a key on a node using
Node.setUserData()
the application can provide a handler
that gets called when the node the object is associated to is being
cloned, imported, or renamed. This can be used by the application to
implement various behaviors regarding the data it associates to the DOM
nodes. This interface defines that handler.
See also the Document Object Model (DOM) Level 3 Core Specification.
- Since:
- 1.5, DOM Level 3
-
Field Summary
Modifier and TypeFieldDescriptionstatic final short
The node is adopted, usingDocument.adoptNode()
.static final short
The node is cloned, usingNode.cloneNode()
.static final short
The node is deleted.static final short
The node is imported, usingDocument.importNode()
.static final short
The node is renamed, usingDocument.renameNode()
. -
Method Summary
-
Field Details
-
NODE_CLONED
static final short NODE_CLONEDThe node is cloned, usingNode.cloneNode()
.- See Also:
-
NODE_IMPORTED
static final short NODE_IMPORTEDThe node is imported, usingDocument.importNode()
.- See Also:
-
NODE_DELETED
static final short NODE_DELETEDThe node is deleted.Note: This may not be supported or may not be reliable in certain environments, such as Java, where the implementation has no real control over when objects are actually deleted.
- See Also:
-
NODE_RENAMED
static final short NODE_RENAMEDThe node is renamed, usingDocument.renameNode()
.- See Also:
-
NODE_ADOPTED
static final short NODE_ADOPTEDThe node is adopted, usingDocument.adoptNode()
.- See Also:
-
-
Method Details
-
handle
This method is called whenever the node for which this handler is registered is imported or cloned.
DOM applications must not raise exceptions in aUserDataHandler
. The effect of throwing exceptions from the handler is DOM implementation dependent.- Parameters:
operation
- Specifies the type of operation that is being performed on the node.key
- Specifies the key for which this handler is being called.data
- Specifies the data for which this handler is being called.src
- Specifies the node being cloned, adopted, imported, or renamed. This isnull
when the node is being deleted.dst
- Specifies the node newly created if any, ornull
.
-