xjavadoc

Class JavaDocReader


(package private) final class JavaDocReader
extends FilterReader

A reader which strips away any spaces and stars at the beginning of javadoc. It also keeps track of line numbers, which is needed for error reporting.

Author:
Aslak Helles?y

Field Summary

private int
_lineOffset
private boolean
atEnd
private boolean
badChar
private int
c
private boolean
endOfLine
private int
lastC
private int
nextChar

Constructor Summary

JavaDocReader(Reader in)

Method Summary

int
available()
Returns the number of bytes that can be read without blocking.
int
getLineOffset()
Returns the line offset we're currently reading
int
read()
Reads a byte of data.
int
read(char[] b, int off, int len)
Reads into an array of bytes.
long
skip(long n)
Skips bytes of input.

Field Details

_lineOffset

private int _lineOffset


atEnd

private boolean atEnd


badChar

private boolean badChar


c

private int c


endOfLine

private boolean endOfLine


lastC

private int lastC


nextChar

private int nextChar

Constructor Details

JavaDocReader

public JavaDocReader(Reader in)

Parameters:
in - the underlying reader, containing javadoc

Method Details

available

public int available()
            throws IOException
Returns the number of bytes that can be read without blocking.

Returns:
the number of available bytes


getLineOffset

public int getLineOffset()
Returns the line offset we're currently reading

Returns:
line in the javadoc.


read

public int read()
            throws IOException
Reads a byte of data. The method will block if no input is available.

Returns:
the byte read, or -1 if the end of the stream is reached.


read

public int read(char[] b,
                int off,
                int len)
            throws IOException
Reads into an array of bytes. Blocks until some input is available.

Parameters:
b - the buffer into which the data is read
off - the start offset of the data
len - the maximum number of bytes read

Returns:
the actual number of bytes read, -1 is returned when the end of the stream is reached.


skip

public long skip(long n)
            throws IOException
Skips bytes of input.

Parameters:
n - bytes to be skipped

Returns:
actual number of bytes skipped