01 /*
02 * Copyright 2000-2005 Sun Microsystems, Inc. All Rights Reserved.
03 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
04 *
05 * This code is free software; you can redistribute it and/or modify it
06 * under the terms of the GNU General Public License version 2 only, as
07 * published by the Free Software Foundation. Sun designates this
08 * particular file as subject to the "Classpath" exception as provided
09 * by Sun in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any questions.
24 */
25
26 package javax.xml.transform.dom;
27
28 import javax.xml.transform.SourceLocator;
29
30 import org.w3c.dom.Node;
31
32 /**
33 * Indicates the position of a node in a source DOM, intended
34 * primarily for error reporting. To use a DOMLocator, the receiver of an
35 * error must downcast the {@link javax.xml.transform.SourceLocator}
36 * object returned by an exception. A {@link javax.xml.transform.Transformer}
37 * may use this object for purposes other than error reporting, for instance,
38 * to indicate the source node that originated a result node.
39 */
40 public interface DOMLocator extends SourceLocator {
41
42 /**
43 * Return the node where the event occurred.
44 *
45 * @return The node that is the location for the event.
46 */
47 public Node getOriginatingNode();
48 }
|