org.apache.maven.doxia.util
Interface ByLineSource

All Known Implementing Classes:

ByLineReaderSource

public interface ByLineSource

The token are the new lines :)

Since:

Nov 4, 2005

Version:

$Id: ByLineSource.java 746978 2009-02-23 12:20:33Z vsiveton $

Author:

Juan F. Codagnone

Method Summary

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

Method Detail

getNextLine

java.lang.String getNextLine()
                             throws ParseException

getNextLine

Returns:

the next line. null if we reached the end.

Throws:

ParseException - on I/O error

getName

java.lang.String getName()

getName

Returns:

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

getLineNumber

int getLineNumber()

getLineNumber

Returns:

the current line number

ungetLine

void ungetLine()
               throws java.lang.IllegalStateException

ungetLine

Throws:

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

unget

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

unget

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

void close()

close the source ...