Class: java.io.BufferedReader

  • public class BufferedReader
  • extends Reader
Read text from a character-input stream, buffering characters so as to provide for the efficient reading of characters, arrays, and lines.

The buffer size may be specified, or the default size may be used. The default is large enough for most purposes.

In general, each read request made of a Reader causes a corresponding read request to be made of the underlying character or byte stream. It is therefore advisable to wrap a BufferedReader around any Reader whose read() operations may be costly, such as FileReaders and InputStreamReaders. For example, 

 BufferedReader in
   = new BufferedReader(new FileReader("foo.in"));
will buffer the input from the specified file. Without buffering, each invocation of read() or readLine() could cause bytes to be read from the file, converted into characters, and then returned, which can be very inefficient.

Programs that use DataInputStreams for textual input can be localized by replacing each DataInputStream with an appropriate BufferedReader.

Authors:
@author Mark Reinhold
See:
@see java.io.FileReader
@see java.io.InputStreamReader
Version:
@version 1.33, 04/01/12
Since:
@since JDK1.1

Inheritance

Superclass tree: Implements:

Methods

  • BufferedReadertop

    public BufferedReader(Reader in)
    Create a buffering character-input stream that uses a default-sized input buffer.
    Parameters:
    @param in A Reader
    Related Links:
    Google Code Search
    Stack Overflow

  • BufferedReadertop

    public BufferedReader(Reader in, int sz)
    Create a buffering character-input stream that uses an input buffer of the specified size.
    Parameters:
    @param in A Reader
    @param sz Input-buffer size
    Exceptions:
    @exception IllegalArgumentException If sz is <_ _0="_0" dd="dd">
    Related Links:
    Google Code Search
    Stack Overflow

  • closetop

    public void close() throws IOException
    Close the stream.
    Exceptions:
    @exception IOException If an I/O error occurs
    Specified by:
    close from Closeable
    Override hierarchy:
    close from Reader
    Related Links:
    Google Code Search
    Stack Overflow

  • marktop

    public void mark(int readAheadLimit) throws IOException
    Mark the present position in the stream. Subsequent calls to reset() will attempt to reposition the stream to this point.
    Parameters:
    @param 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.
    Exceptions:
    @exception IllegalArgumentException If readAheadLimit is < 0
    @exception IOException If an I/O error occurs
    Override hierarchy:
    mark from Reader
    Related Links:
    Google Code Search
    Stack Overflow

  • markSupportedtop

    public boolean markSupported()
    Tell whether this stream supports the mark() operation, which it does.
    Return:
    @return true if and only if this stream supports the mark operation.
    Override hierarchy:
    markSupported from Reader
    Related Links:
    Google Code Search
    Stack Overflow

  • readtop

    public int read() throws IOException
    Read a single character.
    Return:
    @return The character read, as an integer in the range 0 to 65535 (0x00-0xffff), or -1 if the end of the stream has been reached
    Exceptions:
    @exception IOException If an I/O error occurs
    Override hierarchy:
    read from Reader
    Related Links:
    Google Code Search
    Stack Overflow

  • readtop

    public int read(char[] cbuf, int off, int len) throws IOException
    Read characters into a portion of an array.

    This method implements the general contract of the corresponding read method of the java.io.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.
    If the first read on the underlying stream returns -1 to indicate end-of-file then this method returns -1. Otherwise this method returns the number of characters actually read.

    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.

    Parameters:
    @param cbuf Destination buffer
    @param off Offset at which to start storing characters
    @param len Maximum number of characters to read
    Return:
    @return The number of characters read, or -1 if the end of the stream has been reached
    Exceptions:
    @exception IOException If an I/O error occurs
    Override hierarchy:
    read from Reader
    Related Links:
    Google Code Search
    Stack Overflow

  • readLinetop

    public String readLine() throws IOException
    Read a line of text. 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 linefeed.
    Return:
    @return 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
    Exceptions:
    @exception IOException If an I/O error occurs
    Related Links:
    Google Code Search
    Stack Overflow

  • readytop

    public boolean ready() throws 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.
    Return:
    @return True if the next read() is guaranteed not to block for input, false otherwise. Note that returning false does not guarantee that the next read will block.
    Exceptions:
    @exception IOException If an I/O error occurs
    Override hierarchy:
    ready from Reader
    Related Links:
    Google Code Search
    Stack Overflow

  • resettop

    public void reset() throws IOException
    Reset the stream to the most recent mark.
    Exceptions:
    @exception IOException If the stream has never been marked, or if the mark has been invalidated
    Override hierarchy:
    reset from Reader
    Related Links:
    Google Code Search
    Stack Overflow

  • skiptop

    public long skip(long n) throws IOException
    Skip characters.
    Parameters:
    @param n The number of characters to skip
    Return:
    @return The number of characters actually skipped
    Exceptions:
    @exception IllegalArgumentException If n is negative.
    @exception IOException If an I/O error occurs
    Override hierarchy:
    skip from Reader
    Related Links:
    Google Code Search
    Stack Overflow