org.w3c.dom
Interface 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.

See also the Document Object Model (DOM) Level 3 Core Specification.

Since:

DOM Level 3

NODE_CLONED

public static final short NODE_CLONED

See Also:

Constant Field Values (src)

NODE_IMPORTED

public static final short NODE_IMPORTED

See Also:

Constant Field Values (src)

NODE_DELETED

public static final short NODE_DELETED

See Also:

Constant Field Values (src)

NODE_RENAMED

public static final short NODE_RENAMED

See Also:

Constant Field Values (src)

NODE_ADOPTED

public static final short NODE_ADOPTED

See Also:

Constant Field Values (src)

handle

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.