# 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](http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407).

### Constant Summary

|---|---|---|
| short | [NODE_ADOPTED](https://developers.google.com/j2objc/javadoc/jre/reference/org/w3c/dom/UserDataHandler.html#NODE_ADOPTED) | The node is adopted, using `Document.adoptNode()`. |
| short | [NODE_CLONED](https://developers.google.com/j2objc/javadoc/jre/reference/org/w3c/dom/UserDataHandler.html#NODE_CLONED) | The node is cloned, using `Node.cloneNode()`. |
| short | [NODE_DELETED](https://developers.google.com/j2objc/javadoc/jre/reference/org/w3c/dom/UserDataHandler.html#NODE_DELETED) | The node is deleted. |
| short | [NODE_IMPORTED](https://developers.google.com/j2objc/javadoc/jre/reference/org/w3c/dom/UserDataHandler.html#NODE_IMPORTED) | The node is imported, using `Document.importNode()`. |
| short | [NODE_RENAMED](https://developers.google.com/j2objc/javadoc/jre/reference/org/w3c/dom/UserDataHandler.html#NODE_RENAMED) | The node is renamed, using `Document.renameNode()`. |

### Public Method Summary

|---|---|
| abstract void | [handle](https://developers.google.com/j2objc/javadoc/jre/reference/org/w3c/dom/UserDataHandler.html#handle(short,%20java.lang.String,%20java.lang.Object,%20org.w3c.dom.Node,%20org.w3c.dom.Node))(short operation, [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) key, [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) data, [Node](https://developers.google.com/j2objc/javadoc/jre/reference/org/w3c/dom/Node.html) src, [Node](https://developers.google.com/j2objc/javadoc/jre/reference/org/w3c/dom/Node.html) dst) This method is called whenever the node for which this handler is registered is imported or cloned. |

## Constants

#### public static final short
**NODE_ADOPTED**

The node is adopted, using `Document.adoptNode()`.
Constant Value: 5

#### public static final short
**NODE_CLONED**

The node is cloned, using `Node.cloneNode()`.
Constant Value: 1

#### 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.
Constant Value: 3

#### public static final short
**NODE_IMPORTED**

The node is imported, using `Document.importNode()`.
Constant Value: 2

#### public static final short
**NODE_RENAMED**

The node is renamed, using `Document.renameNode()`.
Constant Value: 4

## Public Methods

#### public abstract void
**handle**
(short operation, [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) key, [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) data, [Node](https://developers.google.com/j2objc/javadoc/jre/reference/org/w3c/dom/Node.html) src, [Node](https://developers.google.com/j2objc/javadoc/jre/reference/org/w3c/dom/Node.html) 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.

##### 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 is `null` when the node is being deleted. |
| dst | Specifies the node newly created if any, or `null`. |
|---|---|