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