1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.maven.api.services.xml;
20
21 public interface Location {
22
23 /**
24 * Return the line number where the current event ends,
25 * returns -1 if none is available.
26 * @return the current line number
27 */
28 int getLineNumber();
29
30 /**
31 * Return the column number where the current event ends,
32 * returns -1 if none is available.
33 * @return the current column number
34 */
35 int getColumnNumber();
36
37 /**
38 * Return the byte or character offset into the input source this location
39 * is pointing to. If the input source is a file or a byte stream then
40 * this is the byte offset into that stream, but if the input source is
41 * a character media then the offset is the character offset.
42 * Returns -1 if there is no offset available.
43 * @return the current offset
44 */
45 int getCharacterOffset();
46
47 /**
48 * Returns the public ID of the XML
49 * @return the public ID, or null if not available
50 */
51 String getPublicId();
52
53 /**
54 * Returns the system ID of the XML
55 * @return the system ID, or null if not available
56 */
57 String getSystemId();
58 }