Package org.apache.maven.doxia.module.apt

Interface AptSource

All Known Implementing Classes:

AptReaderSource

public interface AptSource

An interface to read apt source documents.

Version:

$Id: AptSource.java 746982 2009-02-23 12:25:50Z vsiveton $

Method Summary

Modifier and Type	Method	Description
int	getLineNumber()	Gets the current line number while parsing the document.
java.lang.String	getName()	Returns the name the apt source document.
java.lang.String	getNextLine()	Returns a line of the apt source document.

Method Detail

getNextLine

java.lang.String getNextLine()
                      throws AptParseException

Returns a line of the apt source document.

Returns:

a line of the apt source.

Throws:

AptParseException - if the document can't be parsed.

getName

java.lang.String getName()

Returns the name the apt source document.

Returns:

the name the apt source document.

getLineNumber

int getLineNumber()

Gets the current line number while parsing the document.

Returns:

the line number.