File Doc Category Size Date Package
UserDataHandler.java API Doc Java SE 5 API 3069 Fri Aug 26 14:58:38 BST 2005 org.w3c.dom

UserDataHandler

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.

since: DOM Level 3

Fields Summary
public static final short
NODE_CLONED
The node is cloned, using Node.cloneNode().
public static final short
NODE_IMPORTED
The node is imported, using Document.importNode().
public 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.
public static final short
NODE_RENAMED
The node is renamed, using Document.renameNode().
public static final short
NODE_ADOPTED
The node is adopted, using Document.adoptNode().
Constructors Summary
Methods Summary
public void handle(short operation, java.lang.String key, java.lang.Object data, org.w3c.dom.Node src, org.w3c.dom.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 a UserDataHandler. The effect of throwing exceptions from the handler is DOM implementation dependent.
param
operation Specifies the type of operation that is being performed on the node.
param
key Specifies the key for which this handler is being called.
param
data Specifies the data for which this handler is being called.
param
src Specifies the node being cloned, adopted, imported, or renamed. This is null when the node is being deleted.
param
dst Specifies the node newly created if any, or null.