UserDataHandler (Java 2 Platform SE 5.0) (original) (raw)

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.

Since:

DOM Level 3

Field Summary
static short	NODE_ADOPTED The node is adopted, using Document.adoptNode().
static short	NODE_CLONED The node is cloned, using Node.cloneNode().
static short	NODE_DELETED The node is deleted.
static short	NODE_IMPORTED The node is imported, using Document.importNode().
static short	NODE_RENAMED The node is renamed, using Document.renameNode().

Method Summary
void	[handle](../../../org/w3c/dom/UserDataHandler.html#handle%28short, java.lang.String, java.lang.Object, org.w3c.dom.Node, org.w3c.dom.Node%29)(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, using Node.cloneNode().

See Also:

Constant Field Values

NODE_IMPORTED

static final short NODE_IMPORTED

The node is imported, using Document.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, using Document.renameNode().

See Also:

Constant Field Values

NODE_ADOPTED

static final short NODE_ADOPTED

The node is adopted, using Document.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 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.

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.