compact2, compact3
org.w3c.dom
Interface UserDataHandler
-
public interface UserDataHandlerWhen associating an object to a key on a node usingNode.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:
- DOM Level 3
-
-
Field Summary
Fields Modifier and Type Field and Description static shortNODE_ADOPTEDThe node is adopted, usingDocument.adoptNode().static shortNODE_CLONEDThe node is cloned, usingNode.cloneNode().static shortNODE_DELETEDThe node is deleted.static shortNODE_IMPORTEDThe node is imported, usingDocument.importNode().static shortNODE_RENAMEDThe node is renamed, usingDocument.renameNode().
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method and Description voidhandle(short operation, String key, Object data, Node src, Node dst)This method is called whenever the node for which this handler is registered is imported or cloned.
-
-
-
Field Detail
NODE_CLONED
static final short NODE_CLONED
The node is cloned, usingNode.cloneNode().- See Also:
- Constant Field Values
NODE_IMPORTED
static final short NODE_IMPORTED
The node is imported, usingDocument.importNode().- See Also:
- Constant Field Values
NODE_DELETED
static final short NODE_DELETED
The 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:
- Constant Field Values
NODE_RENAMED
static final short NODE_RENAMED
The node is renamed, usingDocument.renameNode().- See Also:
- Constant Field Values
NODE_ADOPTED
static final short NODE_ADOPTED
The node is adopted, usingDocument.adoptNode().- See Also:
- Constant Field Values
-
Method Detail
handle
void handle(short operation, String key, Object data, Node src, Node dst)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 isnullwhen the node is being deleted. -
dst- Specifies the node newly created if any, ornull.
-
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
