Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  * Copyright (c) 2004 World Wide Web Consortium,
  * (Massachusetts Institute of Technology, European Research Consortium for
  * Informatics and Mathematics, Keio University). All Rights Reserved. This
  * work is distributed under the W3C(r) Software License [1] in the hope that
  * it will be useful, but WITHOUT ANY WARRANTY; without even the implied
 * [1]
package org.w3c.dom;

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.

DOM Level 3
public interface UserDataHandler {
    // OperationType
The node is cloned, using Node.cloneNode().
    public static final short NODE_CLONED               = 1;
The node is imported, using Document.importNode().
    public static final short NODE_IMPORTED             = 2;
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_DELETED              = 3;
The node is renamed, using Document.renameNode().
    public static final short NODE_RENAMED              = 4;
The node is adopted, using Document.adoptNode().
    public static final short NODE_ADOPTED              = 5;

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.

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.
    public void handle(short operation
                       String key
                       Object data
                       Node src
                       Node dst);
New to GrepCode? Check out our FAQ X