org.apache.maven.doxia.module.apt

Interface AptSource

All Known Implementing Classes:

AptReaderSource

public interface AptSource

An interface to read apt source documents.

Method Summary

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

Method Detail

getNextLine

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

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.