KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > javax > xml > transform > dom > DOMLocator


1 /*
2  * Copyright 2004 Sun Microsystems, Inc. All rights reserved.
3  * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
4  */
5
6 /*
7  * @(#)DOMLocator.java 1.10 03/12/19
8  */
9 package javax.xml.transform.dom;
10
11 import javax.xml.transform.SourceLocator JavaDoc;
12
13 import org.w3c.dom.Node JavaDoc;
14
15
16 /**
17  * Indicates the position of a node in a source DOM, intended
18  * primarily for error reporting. To use a DOMLocator, the receiver of an
19  * error must downcast the {@link javax.xml.transform.SourceLocator}
20  * object returned by an exception. A {@link javax.xml.transform.Transformer}
21  * may use this object for purposes other than error reporting, for instance,
22  * to indicate the source node that originated a result node.
23  */
24 public interface DOMLocator extends SourceLocator JavaDoc {
25
26     /**
27      * Return the node where the event occurred.
28      *
29      * @return The node that is the location for the event.
30      */
31     public Node JavaDoc getOriginatingNode();
32 }
33
34
Popular Tags