com.starteam.util

Class LineReader

java.lang.Object

java.io.Reader

com.starteam.util.LineReader

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, java.lang.Readable

public class LineReader
extends java.io.Reader

A Line Reader is a subclass of Reader, which implements its own buffer. It has extra functionality for readLine, keeping a tally of the possible eol's that were found in the stream, so that we can determine what eol was really used.

Constructor Summary

Constructors

Constructor and Description
LineReader(java.io.Reader in) Create a buffering character-input stream that uses a default-sized input buffer.
LineReader(java.io.Reader in, int sz) Create a buffering character-input stream that uses an input buffer of the specified size.

Method Summary

Modifier and Type	Method and Description
void	close() Close the stream.
File.EOLFormat	getEOLFormat() Returns the File.EOLFormat we were able to guess by reading the text.
int	getLastEOL()
void	mark(int readAheadLimit) Mark the present position in the stream.
boolean	markSupported() Tell whether this stream supports the mark() operation, which it does.
int	read() Read a single character.
int	read(char[] cbuf, int off, int len) Read characters into a portion of an array.
java.lang.String	readLine() Read a line of text.
boolean	ready() Tell whether this stream is ready to be read.
void	reset() Reset the stream to the most recent mark.
long	skip(long n) Skip characters.

Methods inherited from class java.io.Reader

read, read

Methods inherited from class java.lang.Object

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

Constructor Detail

LineReader

public LineReader(java.io.Reader in,
                  int sz)

Create a buffering character-input stream that uses an input buffer of the specified size.

Parameters:

in - A Reader

sz - Input-buffer size

Throws:

java.lang.IllegalArgumentException - If sz is < 4

LineReader

public LineReader(java.io.Reader in)

Create a buffering character-input stream that uses a default-sized input buffer.

Parameters:

in - A Reader

Method Detail

read

public int read()
         throws java.io.IOException

Read a single character.

Overrides:

read in class java.io.Reader

Throws:

java.io.IOException - If an I/O error occurs

read

public int read(char[] cbuf,
                int off,
                int len)
         throws java.io.IOException

Read characters into a portion of an array.

Ordinarily this method takes characters from this stream's character buffer, filling it from the underlying stream as necessary. If, however, the buffer is empty, the mark is not valid, and the requested length is at least as large as the buffer, then this method will read characters directly from the underlying stream into the given array. Thus redundant BufferedReaders will not copy data unnecessarily.

Specified by:

read in class java.io.Reader

Parameters:

cbuf - Destination buffer

off - Offset at which to start storing characters

len - Maximum number of characters to read

Returns:

The number of bytes read, or -1 if the end of the stream has been reached

Throws:

java.io.IOException - If an I/O error occurs

getLastEOL

public int getLastEOL()

readLine

public java.lang.String readLine()
                          throws java.io.IOException

Read a line of text. CR7966: A line is considered to be terminated by any one of a line feed ('\n'), a carriage return ('\r'), or a carriage return followed immediately by a line feed, in their properly encoded format for the file.

Returns:

A String containing the contents of the line, not including any line-termination characters, or null if the end of the stream has been reached

Throws:

java.io.IOException - If an I/O error occurs

skip

public long skip(long n)
          throws java.io.IOException

Skip characters.

Overrides:

skip in class java.io.Reader

Parameters:

n - The number of characters to skip

Returns:

The number of characters actually skipped

Throws:

java.io.IOException - If an I/O error occurs

ready

public boolean ready()
              throws java.io.IOException

Tell whether this stream is ready to be read. A buffered character stream is ready if the buffer is not empty, or if the underlying character stream is ready.

Overrides:

ready in class java.io.Reader

Throws:

java.io.IOException - If an I/O error occurs

markSupported

public boolean markSupported()

Tell whether this stream supports the mark() operation, which it does.

Overrides:

markSupported in class java.io.Reader

mark

public void mark(int readAheadLimit)
          throws java.io.IOException

Mark the present position in the stream. Subsequent calls to reset() will attempt to reposition the stream to this point.

Overrides:

mark in class java.io.Reader

Parameters:

readAheadLimit - Limit on the number of characters that may be read while still preserving the mark. After reading this many characters, attempting to reset the stream may fail. A limit value larger than the size of the input buffer will cause a new buffer to be allocated whose size is no smaller than limit. Therefore large values should be used with care.

Throws:

java.lang.IllegalArgumentException - If readAheadLimit is < 0

java.io.IOException - If an I/O error occurs

reset

public void reset()
           throws java.io.IOException

Reset the stream to the most recent mark.

Overrides:

reset in class java.io.Reader

Throws:

java.io.IOException - If the stream has never been marked, or if the mark has been invalidated

close

public void close()
           throws java.io.IOException

Close the stream.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in class java.io.Reader

Throws:

java.io.IOException - If an I/O error occurs

getEOLFormat

public File.EOLFormat getEOLFormat()

Returns the File.EOLFormat we were able to guess by reading the text.

Returns:

int