1/*
2 * Copyright (c) 2004 World Wide Web Consortium,
3 *
4 * (Massachusetts Institute of Technology, European Research Consortium for
5 * Informatics and Mathematics, Keio University). All Rights Reserved. This
6 * work is distributed under the W3C(r) Software License [1] in the hope that
7 * it will be useful, but WITHOUT ANY WARRANTY; without even the implied
8 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
9 *
10 * [1] http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231
11 */
12
13package org.w3c.dom;
14
15/**
16 * <code>DOMLocator</code> is an interface that describes a location (e.g.
17 * where an error occurred).
18 * <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>.
19 * @since DOM Level 3
20 */
21public interface DOMLocator {
22    /**
23     * The line number this locator is pointing to, or <code>-1</code> if
24     * there is no column number available.
25     */
26    public int getLineNumber();
27
28    /**
29     * The column number this locator is pointing to, or <code>-1</code> if
30     * there is no column number available.
31     */
32    public int getColumnNumber();
33
34    /**
35     * The byte offset into the input source this locator is pointing to or
36     * <code>-1</code> if there is no byte offset available.
37     */
38    public int getByteOffset();
39
40    /**
41     * 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
42     * <code>-1</code> if there is no UTF-16 offset available.
43     */
44    public int getUtf16Offset();
45
46    /**
47     * The node this locator is pointing to, or <code>null</code> if no node
48     * is available.
49     */
50    public Node getRelatedNode();
51
52    /**
53     * The URI this locator is pointing to, or <code>null</code> if no URI is
54     * available.
55     */
56    public String getUri();
57
58}
59