BufferedReader

See also:

• FileReader
• InputStreamReader
• Files.newBufferedReader(Path)

BufferedReader

public BufferedReader (Reader in, 
                int sz)

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

BufferedReader

public BufferedReader (Reader in)

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

close

public void close ()

Closes the stream and releases any system resources associated with it. Once the stream has been closed, further read(), ready(), mark(), reset(), or skip() invocations will throw an IOException. Closing a previously closed stream has no effect.

lines

public Stream<String> lines ()

Returns a Stream, the elements of which are lines read from this BufferedReader. The Stream is lazily populated, i.e., read only occurs during the terminal stream operation.

The reader must not be operated on during the execution of the terminal stream operation. Otherwise, the result of the terminal stream operation is undefined.

After execution of the terminal stream operation there are no guarantees that the reader will be at a specific position from which to read the next character or line.

If an IOException is thrown when accessing the underlying BufferedReader, it is wrapped in an UncheckedIOException which will be thrown from the Stream method that caused the read to take place. This method will return a Stream if invoked on a BufferedReader that is closed. Any operation on that stream that requires reading from the BufferedReader after it is closed, will cause an UncheckedIOException to be thrown.

mark

public void mark (int readAheadLimit)

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

markSupported

public boolean markSupported ()

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

read

public int read ()

Reads a single character.

read

public int read (char[] cbuf, 
                int off, 
                int len)

Reads characters into a portion of an array.

This method implements the general contract of the corresponding read method of the Reader class. As an additional convenience, it attempts to read as many characters as possible by repeatedly invoking the read method of the underlying stream. This iterated read continues until one of the following conditions becomes true:

• The specified number of characters have been read,
• The read method of the underlying stream returns -1, indicating end-of-file, or
• The ready method of the underlying stream returns false, indicating that further input requests would block.

Subclasses of this class are encouraged, but not required, to attempt to read as many characters as possible in the same fashion.

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.

readLine

public String readLine ()

Reads a line of text. A line is considered to be terminated by any one of a line feed ('\n'), a carriage return ('\r'), a carriage return followed immediately by a line feed, or by reaching the end-of-file (EOF).

ready

public boolean ready ()

Tells 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.

reset

public void reset ()

Resets the stream to the most recent mark.

skip

public long skip (long n)

Skips characters.