All Downloads are FREE. Search and download functionalities are using the official Maven repository.

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

There is a newer version: 1.3.1
Show newest version
/*
 * Portions Copyright  2000-2008 Sun Microsystems, Inc. All Rights
 * Reserved.  Use is subject to license terms.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER
 * 
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License version
 * 2 only, as published by the Free Software Foundation.
 * 
 * This program 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
 * General Public License version 2 for more details (a copy is
 * included at /legal/license.txt).
 * 
 * You should have received a copy of the GNU General Public License
 * version 2 along with this work; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA
 * 
 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
 * Clara, CA 95054 or visit www.sun.com if you need additional
 * information or have any 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
 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 *
 * [1] http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231
 */

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 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); }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy