Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
AptSource |
|
| 1.0;1 |
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 | * @version $Id: AptSource.java 746982 2009-02-23 12:25:50Z vsiveton $ | |
26 | */ | |
27 | public interface AptSource | |
28 | { | |
29 | /** | |
30 | * Returns a line of the apt source document. | |
31 | * | |
32 | * @return a line of the apt source. | |
33 | * @throws org.apache.maven.doxia.module.apt.AptParseException if the document can't be parsed. | |
34 | */ | |
35 | String getNextLine() | |
36 | throws AptParseException; | |
37 | ||
38 | /** | |
39 | * Returns the name the apt source document. | |
40 | * | |
41 | * @return the name the apt source document. | |
42 | */ | |
43 | String getName(); | |
44 | ||
45 | /** | |
46 | * Gets the current line number while parsing the document. | |
47 | * | |
48 | * @return the line number. | |
49 | */ | |
50 | int getLineNumber(); | |
51 | } | |
52 |