Class BufferedReader

public BufferedReader(Reader in)

Create a new BufferedReader that will read from the specified subordinate stream with a default buffer size of 8192 chars.

Parameters:

in - The subordinate stream to read from

public BufferedReader(Reader in,
                      int size)

Create a new BufferedReader that will read from the specified subordinate stream with a buffer size that is specified by the caller.

Parameters:

in - The subordinate stream to read from

size - The buffer size to use

Throws:

IllegalArgumentException - if size <= 0

public void close()
            throws IOException

This method closes the underlying stream and frees any associated resources.

Specified by:

close in interface Closeable

close in interface AutoCloseable

Overrides:

close in interface Reader

Throws:

IOException - If an error occurs

public void mark(int readLimit)
            throws IOException

Mark a position in the input to which the stream can be "reset" by calling the reset() method. The parameter readLimit is the number of chars that can be read from the stream after setting the mark before the mark becomes invalid. For example, if mark() is called with a read limit of 10, then when 11 chars of data are read from the stream before the reset() method is called, then the mark is invalid and the stream object instance is not required to remember the mark.

Note that the number of chars that can be remembered by this method can be greater than the size of the internal read buffer. It is also not dependent on the subordinate stream supporting mark/reset functionality.

Overrides:

mark in interface Reader

Parameters:

readLimit - The number of chars that can be read before the mark becomes invalid

Throws:

IOException - If an error occurs

IllegalArgumentException - if readLimit is negative.

public boolean markSupported()

Returns true to indicate that this class supports mark/reset functionality.

Overrides:

markSupported in interface Reader

Returns:

true

public int read()
            throws IOException

Overrides:

read in interface Reader

public int read(char[] buf,
                int offset,
                int count)
            throws IOException

This method read chars from a stream and stores them into a caller supplied buffer. It starts storing the data at index offset into the buffer and attempts to read len chars. This method can return before reading the number of chars requested. The actual number of chars read is returned as an int. A -1 is returned to indicate the end of the stream.

This method will block until some data can be read.

Parameters:

buf - The array into which the chars read should be stored

offset - The offset into the array to start storing chars

count - The requested number of chars to read

Returns:

The actual number of chars read, or -1 if end of stream.

Throws:

IOException - If an error occurs.

IndexOutOfBoundsException - If offset and count are not valid regarding buf.

public String readLine()
            throws IOException

This method reads a single line of text from the input stream, returning it as a String. A line is terminated by "\n", a "\r", or an "\r\n" sequence. The system dependent line separator is not used. The line termination characters are not returned in the resulting String.

Returns:

The line of text read, or null if end of stream.

Throws:

IOException - If an error occurs

public boolean ready()
            throws IOException

This method determines whether or not a stream is ready to be read. If this method returns false then this stream could (but is not guaranteed to) block on the next read attempt.

Overrides:

ready in interface Reader

Returns:

true if this stream is ready to be read, false otherwise

Throws:

IOException - If an error occurs

public void reset()
            throws IOException

Reset the stream to the point where the mark() method was called. Any chars that were read after the mark point was set will be re-read during subsequent reads.

This method will throw an IOException if the number of chars read from the stream since the call to mark() exceeds the mark limit passed when establishing the mark.

Overrides:

reset in interface Reader

Throws:

IOException - If an error occurs;

public long skip(long count)
            throws IOException

This method skips the specified number of chars in the stream. It returns the actual number of chars skipped, which may be less than the requested amount.

This method first discards chars in the buffer, then calls the skip method on the underlying stream to skip the remaining chars.

Overrides:

skip in interface Reader

Parameters:

count - The requested number of chars to skip

Returns:

The actual number of chars skipped.

Throws:

IOException - If an error occurs.

IllegalArgumentException - If count is negative.