001package org.apache.maven.doxia.module.apt; 002 003/* 004 * Licensed to the Apache Software Foundation (ASF) under one 005 * or more contributor license agreements. See the NOTICE file 006 * distributed with this work for additional information 007 * regarding copyright ownership. The ASF licenses this file 008 * to you under the Apache License, Version 2.0 (the 009 * "License"); you may not use this file except in compliance 010 * with the License. You may obtain a copy of the License at 011 * 012 * http://www.apache.org/licenses/LICENSE-2.0 013 * 014 * Unless required by applicable law or agreed to in writing, 015 * software distributed under the License is distributed on an 016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 017 * KIND, either express or implied. See the License for the 018 * specific language governing permissions and limitations 019 * under the License. 020 */ 021 022/** 023 * An interface to read apt source documents. 024 */ 025public interface AptSource 026{ 027 /** 028 * Returns a line of the apt source document. 029 * 030 * @return a line of the apt source. 031 * @throws org.apache.maven.doxia.module.apt.AptParseException if the document can't be parsed. 032 */ 033 String getNextLine() 034 throws AptParseException; 035 036 /** 037 * Returns the name the apt source document. 038 * 039 * @return the name the apt source document. 040 */ 041 String getName(); 042 043 /** 044 * Gets the current line number while parsing the document. 045 * 046 * @return the line number. 047 */ 048 int getLineNumber(); 049} 050