01: /*
02: * Copyright (c) 2004 World Wide Web Consortium,
03: *
04: * (Massachusetts Institute of Technology, European Research Consortium for
05: * Informatics and Mathematics, Keio University). All Rights Reserved. This
06: * work is distributed under the W3C(r) Software License [1] in the hope that
07: * it will be useful, but WITHOUT ANY WARRANTY; without even the implied
08: * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
09: *
10: * [1] http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231
11: */
12: package org.w3c.dom;
13:
14: // $Id: UserDataHandler.java 41038 2006-02-08 07:03:26Z starksm $
15:
16: /**
17: * When associating an object to a key on a node using
18: * <code>Node.setUserData()</code> the application can provide a handler
19: * that gets called when the node the object is associated to is being
20: * cloned, imported, or renamed. This can be used by the application to
21: * implement various behaviors regarding the data it associates to the DOM
22: * nodes. This interface defines that handler.
23: * <p>See also the <a href='http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407'>Document Object Model (DOM) Level 3 Core Specification</a>.
24: *
25: * @since DOM Level 3
26: */
27: public interface UserDataHandler {
28:
29: public static final short NODE_CLONED = 1;
30: public static final short NODE_IMPORTED = 2;
31: public static final short NODE_DELETED = 3;
32: public static final short NODE_RENAMED = 4;
33: public static final short NODE_ADOPTED = 5;
34:
35: /**
36: * This method is called whenever the node for which this handler is
37: * registered is imported or cloned.
38: * <br> DOM applications must not raise exceptions in a
39: * <code>UserDataHandler</code>. The effect of throwing exceptions from
40: * the handler is DOM implementation dependent.
41: */
42: public void handle(short operation, String key, Object data,
43: Node src, Node dst);
44:
45: }
|