ByLineReaderSource (Doxia 1.8 API)

java.lang.Object
- org.apache.maven.doxia.util.ByLineReaderSource

All Implemented Interfaces:

ByLineSource
```
public class ByLineReaderSource
extends Object
implements ByLineSource
```
ByLineSource default implementation

Version:

$Id$

Constructor Summary

Constructors
Constructor and Description

ByLineReaderSource(Reader in)
Creates the ByLineReaderSource.

ByLineReaderSource(Reader in, String name)

Constructors
Constructor and Description
`ByLineReaderSource(Reader in)` Creates the ByLineReaderSource.
`ByLineReaderSource(Reader in, String name)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`close()` close the source.
`int`	`getLineNumber()` getLineNumber.
`String`	`getName()` getName.
`String`	`getNextLine()` getNextLine.
`void`	`unget(String s)` unget.
`void`	`ungetLine()` ungetLine.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ByLineReaderSource
```
public ByLineReaderSource(Reader in)
```
    Creates the ByLineReaderSource.
    
    Parameters:
    in - real source :)
  - ByLineReaderSource
```
public ByLineReaderSource(Reader in,
                  String name)
```
- Method Detail
  - getNextLine
```
public final String getNextLine()
                         throws ParseException
```
    getNextLine.
    
    Specified by:
    
    getNextLine in interface ByLineSource
    
    Returns:
    the next line. null if we reached the end.
    
    Throws:
    
    ParseException - on I/O error
  - getName
```
public final String getName()
```
    getName.
    
    Specified by:
    
    getName in interface ByLineSource
    
    Returns:
    the name of the input. could be the filename for example.
  - getLineNumber
```
public final int getLineNumber()
```
    getLineNumber.
    
    Specified by:
    
    getLineNumber in interface ByLineSource
    
    Returns:
    the current line number.
  - close
```
public final void close()
```
    close the source.
    
    Specified by:
    
    close in interface ByLineSource
  - ungetLine
```
public final void ungetLine()
```
    ungetLine.
    This should throw a java.lang.IllegalStateException if called more than one time without calling getNextLine().
    
    Specified by:
    
    ungetLine in interface ByLineSource
  - unget
```
public final void unget(String s)
```
    unget.
    
    Specified by:
    
    unget in interface ByLineSource
    
    Parameters:
    s - some text to push back to the parser. This should throw a java.lang.IllegalStateException if called more than one time without calling getNextLine().

Class ByLineReaderSource

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ByLineReaderSource

ByLineReaderSource

Method Detail

getNextLine

getName

getLineNumber

close

ungetLine

unget