AptReaderSource (Doxia :: APT Module 1.9 API)

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- org.apache.maven.doxia.module.apt.AptReaderSource

All Implemented Interfaces:

AptSource
```
public class AptReaderSource
extends Object
implements AptSource
```
Reader for apt source documents.

Version:

$Id$

Constructor Summary

Constructors
Constructor and Description
`AptReaderSource(Reader in)` Constructor: initialize reader.
`AptReaderSource(Reader in, String name)` Constructor: initialize reader.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`close()` Closes the reader associated with this AptReaderSource.
`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.

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

- Constructor Detail
  - AptReaderSource
```
public AptReaderSource(Reader in)
```
    Constructor: initialize reader.
    
    Parameters:
    in - the reader.
  - AptReaderSource
```
public AptReaderSource(Reader in,
               String name)
```
    Constructor: initialize reader.
    
    Parameters:
    in - the reader.
    name - the name of the source
- Method Detail
  - getNextLine
```
public String getNextLine()
                   throws AptParseException
```
    Returns a line of the apt source document.
    
    Specified by:
    
    getNextLine in interface AptSource
    
    Returns:
    a line of the apt source.
    
    Throws:
    
    AptParseException - if the document can't be parsed.
  - getName
```
public String getName()
```
    Returns the name the apt source document.
    
    Specified by:
    
    getName in interface AptSource
    
    Returns:
    the name the apt source document.
  - getLineNumber
```
public int getLineNumber()
```
    Gets the current line number while parsing the document.
    
    Specified by:
    
    getLineNumber in interface AptSource
    
    Returns:
    the line number.
  - close
```
public void close()
```
    Closes the reader associated with this AptReaderSource.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2005–2019 The Apache Software Foundation. All rights reserved.