1 /*
2  * Copyright (c) 2000, 2005, Oracle and/or its affiliates. All rights reserved.
3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4  *
5  * This code is free software; you can redistribute it and/or modify it
6  * under the terms of the GNU General Public License version 2 only, as
7  * published by the Free Software Foundation.  Oracle designates this
8  * particular file as subject to the "Classpath" exception as provided
9  * by Oracle 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22  * or visit www.oracle.com if you need additional information or have any
23  * 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 /**
34  * Indicates the position of a node in a source DOM, intended
35  * primarily for error reporting.  To use a DOMLocator, the receiver of an
36  * error must downcast the {@link javax.xml.transform.SourceLocator}
37  * object returned by an exception. A {@link javax.xml.transform.Transformer}
38  * may use this object for purposes other than error reporting, for instance,
39  * to indicate the source node that originated a result node.
40  *
41  * @since 1.4
42  */
43 public interface DOMLocator extends SourceLocator {
44 
45     /**
46      * Return the node where the event occurred.
47      *
48      * @return The node that is the location for the event.
49      */
getOriginatingNode()50     public Node getOriginatingNode();
51 }
52