org.apache.maven.doxia.module.common
Interface ByLineSource

All Known Implementing Classes:

ByLineReaderSource

public interface ByLineSource

The token are the new lines :)

Since:

Nov 4, 2005

Author:

Juan F. Codagnone

Method Summary

void	close() close the source ...
int	getLineNumber()
java.lang.String	getName()
java.lang.String	getNextLine()
void	unget(java.lang.String s)
void	ungetLine()

Method Detail

getNextLine

public java.lang.String getNextLine()
                             throws ParseException

Returns:

the next line. null if we reached the end.

Throws:

ParseException - on I/O error

getName

public java.lang.String getName()

Returns:

the name of the input. could be the filename for example

getLineNumber

public int getLineNumber()

Returns:

the current line number

ungetLine

public void ungetLine()
               throws java.lang.IllegalStateException

Throws:

java.lang.IllegalStateException - if the ungetLine/unget is called more than one time without calling getNextLine()

unget

public void unget(java.lang.String s)
           throws java.lang.IllegalStateException

Parameters:

s - some text to push back to the parser

Throws:

java.lang.IllegalStateException - if the ungetLine/unget is called more than one time without calling getNextLine()

close

public void close()

close the source ...