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.module.apt; 20 21 /** 22 * An interface to read apt source documents. 23 */ 24 public interface AptSource { 25 /** 26 * Returns a line of the apt source document. 27 * 28 * @return a line of the apt source. 29 * @throws org.apache.maven.doxia.module.apt.AptParseException if the document can't be parsed. 30 */ 31 String getNextLine() throws AptParseException; 32 33 /** 34 * Returns the name the apt source document. 35 * 36 * @return the name the apt source document. 37 */ 38 String getName(); 39 40 /** 41 * Gets the current line number while parsing the document. 42 * 43 * @return the line number. 44 */ 45 int getLineNumber(); 46 }