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.doxia.sink;
20
21 /**
22 * Interface for associating a {@link Sink} event with a document location.
23 * @since 2.0.0
24 */
25 public interface Locator {
26 /**
27 * Returns the underlying source reference (for file based documents a relative file path, otherwise an arbitrary string or {@code null}).
28 * @return the source for the sink event (may be {@code null})
29 */
30 String getReference();
31
32 /**
33 * Returns the line number for the sink event (starting from 1).
34 * If it is not known returns {@code -1}.
35 *
36 * @return the line number for the sink event
37 */
38 int getLineNumber();
39
40 /**
41 * Returns the column number for the sink event (starting from 1).
42 * If it is not known returns {@code -1}.
43 *
44 * @return the column number for the sink event
45 */
46 int getColumnNumber();
47 }