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 *
025 * @version $Id: AptSource.html 905940 2014-04-12 16:27:29Z hboutemy $
026 */
027public interface AptSource
028{
029    /**
030     * Returns a line of the apt source document.
031     *
032     * @return a line of the apt source.
033     * @throws org.apache.maven.doxia.module.apt.AptParseException if the document can't be parsed.
034     */
035    String getNextLine()
036        throws AptParseException;
037
038    /**
039     * Returns the name the apt source document.
040     *
041     * @return the name the apt source document.
042     */
043    String getName();
044
045    /**
046     * Gets the current line number while parsing the document.
047     *
048     * @return the line number.
049     */
050    int getLineNumber();
051}
052