org.w3c.dom.UserDataHandler Maven / Gradle / Ivy

/*
 * Copyright (C) 2005 by Quentin Anciaux
 *
 * This library is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Library General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or (at your
 * option) any later version.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Library General Public License
 * along with this library; if not, write to the Free Software Foundation,
 * Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 *
 *	@author Quentin Anciaux
 */

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 .
 * 
 *
 * @since 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.
     *
     * @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.
     */
    public void handle(
        short operation,
        String key,
        Object data,
        Node src,
        Node dst
    );
}