org.apache.maven.doxia.module.common
Class ByLineReaderSource

java.lang.Object
  org.apache.maven.doxia.module.common.ByLineReaderSource

All Implemented Interfaces:

ByLineSource

public class ByLineReaderSource

extends java.lang.Object

implements ByLineSource

ByLineSource default implementation

Constructor Summary

ByLineReaderSource(java.io.Reader in)
Creates the ByLineReaderSource.

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()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ByLineReaderSource

public ByLineReaderSource(java.io.Reader in)

Creates the ByLineReaderSource.

Parameters:

in - real source :)

Method Detail

getNextLine

public final java.lang.String getNextLine()
                                   throws AptParseException

Specified by:

getNextLine in interface ByLineSource

Returns:

the next line. null if we reached the end.

Throws:

AptParseException

See Also:

ByLineSource.getNextLine()

getName

public final java.lang.String getName()

Specified by:

getName in interface ByLineSource

Returns:

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

See Also:

ByLineSource.getName()

getLineNumber

public final int getLineNumber()

Specified by:

getLineNumber in interface ByLineSource

Returns:

the current line number

See Also:

ByLineSource.getLineNumber()

close

public final void close()

Description copied from interface: ByLineSource

close the source ...

Specified by:

close in interface ByLineSource

See Also:

ByLineSource.close()

ungetLine

public final void ungetLine()
                     throws java.lang.IllegalStateException

Specified by:

ungetLine in interface ByLineSource

Throws:

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

See Also:

ByLineSource.ungetLine()

unget

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

Specified by:

unget in interface ByLineSource

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()

See Also:

ByLineSource.unget(String)