Home | History | Annotate | Download | only in dom
      1 /*
      2  * Licensed to the Apache Software Foundation (ASF) under one or more
      3  * contributor license agreements.  See the NOTICE file distributed with
      4  * this work for additional information regarding copyright ownership.
      5  * The ASF licenses this file to You under the Apache License, Version 2.0
      6  * (the "License"); you may not use this file except in compliance with
      7  * the License.  You may obtain a copy of the License at
      8  *
      9  *     http://www.apache.org/licenses/LICENSE-2.0
     10  *
     11  * Unless required by applicable law or agreed to in writing, software
     12  * distributed under the License is distributed on an "AS IS" BASIS,
     13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     14  * See the License for the specific language governing permissions and
     15  * limitations under the License.
     16  */
     17 
     18 // $Id: DOMLocator.java 446598 2006-09-15 12:55:40Z jeremias $
     19 
     20 package javax.xml.transform.dom;
     21 
     22 import javax.xml.transform.SourceLocator;
     23 import org.w3c.dom.Node;
     24 
     25 
     26 /**
     27  * Indicates the position of a node in a source DOM, intended
     28  * primarily for error reporting.  To use a DOMLocator, the receiver of an
     29  * error must downcast the {@link javax.xml.transform.SourceLocator}
     30  * object returned by an exception. A {@link javax.xml.transform.Transformer}
     31  * may use this object for purposes other than error reporting, for instance,
     32  * to indicate the source node that originated a result node.
     33  */
     34 public interface DOMLocator extends SourceLocator {
     35 
     36     /**
     37      * Return the node where the event occurred.
     38      *
     39      * @return The node that is the location for the event.
     40      */
     41     public Node getOriginatingNode();
     42 }
     43 
     44