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