java.io
Class BufferedReader

java.lang.Object
  |
  +--java.io.Reader
        |
        +--java.io.BufferedReader
Direct Known Subclasses:
LineNumberReader

public class BufferedReader
extends Reader

Safe: 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.

Since:
JDK1.1
Version:
1.28, 01/12/03
Author:
Mark Reinhold
See Also:
FileReader, InputStreamReader

Field Summary
private  char[] cb
           
private static int defaultCharBufferSize
           
private static int defaultExpectedLineLength
           
private  Reader in
           
private static int INVALIDATED
           
private  int markedChar
           
private  boolean markedSkipLF
          The skipLF flag when the mark was set
private  int nChars
           
private  int nextChar
           
private  int readAheadLimit
           
private  boolean skipLF
          If the next character is a line feed, skip it
private static int UNMARKED
           
 
Fields inherited from class java.io.Reader
lock
 
Constructor Summary
BufferedReader(Reader in)
          Enabled: Create a buffering character-input stream that uses a default-sized input buffer.
BufferedReader(Reader in, int sz)
          Enabled: Create a buffering character-input stream that uses an input buffer of the specified size.
 
Method Summary
 void close()
          Enabled: Close the stream.
private  void ensureOpen()
          Check to make sure that the stream has not been closed
private  void fill()
          Fill the input buffer, taking the mark into account if it is valid.
 String getText()
          Added: Gets the rest of the input as a String (equivalently, bare Twine), normalizing newlines into '\n's.
 Twine getTwine(String url)
          Added: Gets the contents of the url as Twine (a text string that remembers where it came from), normalizing newlines into '\n's.
 void iterate(AssocFunc func)
          Added: Enumerates lineNumber => String (text line) associations.
 void iterate(AssocFunc func, String optURL)
          Added: Enumerates lineNumber => String/Twine (text line) associations.
 void mark(int readAheadLimit)
          Enabled: Mark the present position in the stream.
 boolean markSupported()
          Enabled: Tell whether this stream supports the mark() operation, which it does.
 int read()
          Enabled: Read a single character.
 int read(char[] cbuf, int off, int len)
          Enabled: Read characters into a portion of an array.
private  int read1(char[] cbuf, int off, int len)
          Read characters into a portion of an array, reading from the underlying stream if necessary.
 String readLine()
          Enabled: Read a line of text.
(package private)  String readLine(boolean ignoreLF)
          Read a line of text.
 boolean ready()
          Enabled: Tell whether this stream is ready to be read.
 void reset()
          Enabled: Reset the stream to the most recent mark.
 long skip(long n)
          Enabled: Skip characters.
 
Methods inherited from class java.io.Reader
read, readChar, readString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

in

private Reader in

cb

private char[] cb

nChars

private int nChars

nextChar

private int nextChar

INVALIDATED

private static final int INVALIDATED

UNMARKED

private static final int UNMARKED

markedChar

private int markedChar

readAheadLimit

private int readAheadLimit

skipLF

private boolean skipLF
If the next character is a line feed, skip it


markedSkipLF

private boolean markedSkipLF
The skipLF flag when the mark was set


defaultCharBufferSize

private static int defaultCharBufferSize

defaultExpectedLineLength

private static int defaultExpectedLineLength
Constructor Detail

BufferedReader

public BufferedReader(Reader in,
                      int sz)
Enabled: Create a buffering character-input stream that uses an input buffer of the specified size.

Parameters:
in - A Reader
sz - Input-buffer size

BufferedReader

public BufferedReader(Reader in)
Enabled: Create a buffering character-input stream that uses a default-sized input buffer.

Parameters:
in - A Reader
Method Detail

ensureOpen

private void ensureOpen()
                 throws IOException
Check to make sure that the stream has not been closed

IOException

fill

private void fill()
           throws IOException
Fill the input buffer, taking the mark into account if it is valid.

IOException

read

public int read()
         throws IOException
Enabled: Read a single character.

Overrides:
read in class Reader
Returns:
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
IOException

read1

private int read1(char[] cbuf,
                  int off,
                  int len)
           throws IOException
Read characters into a portion of an array, reading from the underlying stream if necessary.

IOException

read

public int read(char[] cbuf,
                int off,
                int len)
         throws IOException
Enabled: Read 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:

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.

Specified by:
read in class Reader
Parameters:
cbuf - Destination buffer
off - Offset at which to start storing characters
len - Maximum number of characters to read
Returns:
The number of characters read, or -1 if the end of the stream has been reached
IOException

readLine

String readLine(boolean ignoreLF)
          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.

Parameters:
ignoreLF - If true, the next '\n' will be skipped
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
IOException
See Also:
java.io.LineNumberReader#readLine()

readLine

public String readLine()
                throws IOException
Enabled: 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.

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
IOException

skip

public long skip(long n)
          throws IOException
Enabled: Skip characters.

Overrides:
skip in class Reader
Parameters:
n - The number of characters to skip
Returns:
The number of characters actually skipped
IOException

ready

public boolean ready()
              throws IOException
Enabled: 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 Reader
Returns:
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.
IOException

markSupported

public boolean markSupported()
Enabled: Tell whether this stream supports the mark() operation, which it does.

Overrides:
markSupported in class Reader
Returns:
true if and only if this stream supports the mark operation.

mark

public void mark(int readAheadLimit)
          throws IOException
Enabled: Mark the present position in the stream. Subsequent calls to reset() will attempt to reposition the stream to this point.

Overrides:
mark in class 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.
IOException

reset

public void reset()
           throws IOException
Enabled: Reset the stream to the most recent mark.

Overrides:
reset in class Reader
IOException

close

public void close()
           throws IOException
Enabled: Close the stream.

Specified by:
close in class Reader
IOException

iterate

public void iterate(AssocFunc func,
                    String optURL)
             throws IOException
Added: Enumerates lineNumber => String/Twine (text line) associations.

Each text line ends with a "\n". If optURL is null, then each text line will be a String. Otherwise, each will be a Twine with location info.

IOException

iterate

public void iterate(AssocFunc func)
             throws Throwable
Added: Enumerates lineNumber => String (text line) associations.

Each text line ends with a "\n". optURL defaults to null.

Throwable

getText

public String getText()
               throws IOException
Added: Gets the rest of the input as a String (equivalently, bare Twine), normalizing newlines into '\n's.

IOException

getTwine

public Twine getTwine(String url)
               throws IOException
Added: Gets the contents of the url as Twine (a text string that remembers where it came from), normalizing newlines into '\n's.

IOException


comments?