1 /*
   2  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   3  *
   4  * This code is free software; you can redistribute it and/or modify it
   5  * under the terms of the GNU General Public License version 2 only, as
   6  * published by the Free Software Foundation.  Oracle designates this
   7  * particular file as subject to the "Classpath" exception as provided
   8  * by Oracle in the LICENSE file that accompanied this code.
   9  *
  10  * This code is distributed in the hope that it will be useful, but WITHOUT
  11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  12  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  13  * version 2 for more details (a copy is included in the LICENSE file that
  14  * accompanied this code).
  15  *
  16  * You should have received a copy of the GNU General Public License version
  17  * 2 along with this work; if not, write to the Free Software Foundation,
  18  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  19  *
  20  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  21  * or visit www.oracle.com if you need additional information or have any
  22  * questions.
  23  */
  24 
  25 /*
  26  * This file is available under and governed by the GNU General Public
  27  * License version 2 only, as published by the Free Software Foundation.
  28  * However, the following notice accompanied the original version of this
  29  * file and, per its terms, should not be removed:
  30  *
  31  * Copyright (c) 2004 World Wide Web Consortium,
  32  *
  33  * (Massachusetts Institute of Technology, European Research Consortium for
  34  * Informatics and Mathematics, Keio University). All Rights Reserved. This
  35  * work is distributed under the W3C(r) Software License [1] in the hope that
  36  * it will be useful, but WITHOUT ANY WARRANTY; without even the implied
  37  * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  38  *
  39  * [1] http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231
  40  */
  41 
  42 package org.w3c.dom;
  43 
  44 /**
  45  * <code>DOMLocator</code> is an interface that describes a location (e.g.
  46  * where an error occurred).
  47  * <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>.
  48  * @since DOM Level 3
  49  */
  50 public interface DOMLocator {
  51     /**
  52      * The line number this locator is pointing to, or <code>-1</code> if
  53      * there is no column number available.
  54      */
  55     public int getLineNumber();
  56 
  57     /**
  58      * The column number this locator is pointing to, or <code>-1</code> if
  59      * there is no column number available.
  60      */
  61     public int getColumnNumber();
  62 
  63     /**
  64      * The byte offset into the input source this locator is pointing to or
  65      * <code>-1</code> if there is no byte offset available.
  66      */
  67     public int getByteOffset();
  68 
  69     /**
  70      * The UTF-16, as defined in [Unicode] and Amendment 1 of [ISO/IEC 10646], offset into the input source this locator is pointing to or
  71      * <code>-1</code> if there is no UTF-16 offset available.
  72      */
  73     public int getUtf16Offset();
  74 
  75     /**
  76      * The node this locator is pointing to, or <code>null</code> if no node
  77      * is available.
  78      */
  79     public Node getRelatedNode();
  80 
  81     /**
  82      * The URI this locator is pointing to, or <code>null</code> if no URI is
  83      * available.
  84      */
  85     public String getUri();
  86 
  87 }