| java.lang.Object
 java.io.Reader
java.io.BufferedReader
All known Subclasses: java.io.LineNumberReader,
| BufferedReader | | public class BufferedReader extends Reader (Code) | | BufferedReader is a buffered character input reader. Buffering allows reading
from character streams more efficiently. If the default size of the buffer is
not practical, another size may be specified. Reading a character from a
Reader class usually involves reading a character from its Stream or
subsequent Reader. It is advisable to wrap a BufferedReader around those
Readers whose read operations may have high latency. For example, the
following code
BufferedReader inReader = new BufferedReader(new FileReader("file.java"));
will buffer input for the file file.java.
See Also: BufferedWriter
since:
1.1 |
| Method Summary | |
| public void | close()
Close the Reader. | | public void | mark(int readlimit)
Set a Mark position in this BufferedReader. | | public boolean | markSupported()
Answers a boolean indicating whether or not this Reader supports mark()
and reset(). | | public int | read()
Reads a single character from this reader and returns the result as an
int. | | public int | read(char[] buffer, int offset, int length)
Reads at most length characters from this BufferedReader
and stores them at offset in the character array
buffer. | | public String | readLine()
Answers a String representing the next line of text
available in this BufferedReader. | | public boolean | ready()
Answers a boolean indicating whether or not this Reader is
ready to be read without blocking. | | public void | reset()
Reset this BufferedReader's position to the last mark()
location. | | public long | skip(long amount)
Skips amount number of characters in this Reader.
Subsequent read()'s will not return these characters
unless reset() is used. |
| BufferedReader | | public BufferedReader(Reader in)(Code) | | Constructs a new BufferedReader on the Reader in. The
default buffer size (8K) is allocated and all reads can now be filtered
through this BufferedReader.
Parameters:
in - the Reader to buffer reads on. |
| BufferedReader | | public BufferedReader(Reader in, int size)(Code) | | Constructs a new BufferedReader on the Reader in. The
buffer size is specified by the parameter size and all
reads can now be filtered through this BufferedReader.
Parameters:
in - the Reader to buffer reads on.
Parameters:
size - the size of buffer to allocate.
throws:
IllegalArgumentException - if the size is <= 0 |
| close | | public void close() throws IOException(Code) | | Close the Reader. This implementation closes the Reader being filtered
and releases the buffer used by this reader. If this BufferedReader has
already been closed, nothing is done.
throws:
IOException - If an error occurs attempting to close this BufferedReader. |
| mark | | public void mark(int readlimit) throws IOException(Code) | | Set a Mark position in this BufferedReader. The parameter
readLimit indicates how many characters can be read before
a mark is invalidated. Sending reset() will reposition the reader back to
the marked position provided readLimit has not been
surpassed.
Parameters:
readlimit - an int representing how many characters must be read beforeinvalidating the mark.
throws:
IOException - If an error occurs attempting mark this BufferedReader.
throws:
IllegalArgumentException - If readlimit is < 0 |
| markSupported | | public boolean markSupported()(Code) | | Answers a boolean indicating whether or not this Reader supports mark()
and reset(). This implementation answers true.
true if mark() and reset() are supported,false otherwise |
| read | | public int read() throws IOException(Code) | | Reads a single character from this reader and returns the result as an
int. The 2 higher-order characters are set to 0. If the end of reader was
encountered then return -1. This implementation either returns a
character from the buffer or if there are no characters available, fill
the buffer then return a character or -1.
the character read or -1 if end of reader.
throws:
IOException - If the BufferedReader is already closed or some other IOerror occurs. |
| read | | public int read(char[] buffer, int offset, int length) throws IOException(Code) | | Reads at most length characters from this BufferedReader
and stores them at offset in the character array
buffer. Returns the number of characters actually read or
-1 if the end of reader was encountered. If all the buffered characters
have been used, a mark has not been set, and the requested number of
characters is larger than this Readers buffer size, this implementation
bypasses the buffer and simply places the results directly into
buffer.
Parameters:
buffer - character array to store the read characters
Parameters:
offset - offset in buf to store the read characters
Parameters:
length - maximum number of characters to read number of characters read or -1 if end of reader.
throws:
IOException - If the BufferedReader is already closed or some other IOerror occurs. |
| readLine | | public String readLine() throws IOException(Code) | | Answers a String representing the next line of text
available in this BufferedReader. A line is represented by 0 or more
characters followed by '\n', '\r',
'\r\n' or end of stream. The String does not
include the newline sequence.
In EBCDIC systems, a new line can also be represented by the
'\u0085' (NEL) character.
the contents of the line or null if no characters were readbefore end of stream.
throws:
IOException - If the BufferedReader is already closed or some other IOerror occurs. |
| ready | | public boolean ready() throws IOException(Code) | | Answers a boolean indicating whether or not this Reader is
ready to be read without blocking. If the result is true,
the next read() will not block. If the result is
false this Reader may or may not block when
read() is sent.
true if the receiver will not block whenread() is called, false if unknownor blocking will occur.
throws:
IOException - If the BufferedReader is already closed or some other IOerror occurs. |
| reset | | public void reset() throws IOException(Code) | | Reset this BufferedReader's position to the last mark()
location. Invocations of read()/skip() will occur from
this new location. If this Reader was not marked, throw IOException.
throws:
IOException - If a problem occurred, the receiver does not supportmark()/reset(), or no mark has been set. |
| skip | | public long skip(long amount) throws IOException(Code) | | Skips amount number of characters in this Reader.
Subsequent read()'s will not return these characters
unless reset() is used. Skipping characters may invalidate
a mark if marklimit is surpassed.
Parameters:
amount - the maximum number of characters to skip. the number of characters actually skipped.
throws:
IOException - If the BufferedReader is already closed or some other IOerror occurs.
throws:
IllegalArgumentException - If amount is negative |
|
|