1 package org.apache.maven.doxia.module.apt;
2
3 /*
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
19 * under the License.
20 */
21
22 /**
23 * An interface to read apt source documents.
24 */
25 public interface AptSource
26 {
27 /**
28 * Returns a line of the apt source document.
29 *
30 * @return a line of the apt source.
31 * @throws org.apache.maven.doxia.module.apt.AptParseException if the document can't be parsed.
32 */
33 String getNextLine()
34 throws AptParseException;
35
36 /**
37 * Returns the name the apt source document.
38 *
39 * @return the name the apt source document.
40 */
41 String getName();
42
43 /**
44 * Gets the current line number while parsing the document.
45 *
46 * @return the line number.
47 */
48 int getLineNumber();
49 }
50