java.io

Class BufferedReader

java.lang.Object

java.io.Reader

java.io.BufferedReader

Direct Known Subclasses:

LineNumberReader

public class BufferedReader
extends Reader

Reads data from a character stream. Characters are buffered. Provides for reading lines terminated by a carriage return \r or a linefeed \n character ignoring any trailing linefeed \n after a carriage return \r (\r\n termination).

Field Summary

Fields inherited from class java.io.Reader

lock

Constructor Summary

Constructors

Constructor and Description
BufferedReader(Reader reader) Creates a buffered stream from the Reader class.
BufferedReader(Reader reader, int bufsiz) Creates a buffered stream from the Reader class.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the stream
void	mark(int limit) Marks a position in the buffered stream.
boolean	markSupported() Indicates whether a stream supports the marking feature.
int	read() Reads a single character.
int	read(char[] arr, int ofs, int len) Reads characters into part of a character array.
String	readLine() Returns the next line of text from the stream (blocking).
boolean	ready() Indicates that there is data ready to be read.
void	reset() Resets the buffer pointer.
long	skip(long len) Skips the specified number of characters in the stream (blocking).
boolean	terminated() Indicates if the last readLine() was terminated.

Methods inherited from class java.io.Reader

read

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BufferedReader

public BufferedReader(Reader reader)

Creates a buffered stream from the Reader class. Uses a default buffer size of 512 characters.

Parameters:

reader - Reader stream object?

BufferedReader

public BufferedReader(Reader reader,
                      int bufsiz)

Creates a buffered stream from the Reader class. The buffer size is specified.

Parameters:

reader - Reader stream object

bufsiz - Desired buffer size?

Method Detail

close

public void close()
           throws IOException

Closes the stream

Specified by:

close in class Reader

Throws:

IOException - with any error

mark

public void mark(int limit)
          throws IOException

Marks a position in the buffered stream. A call to reset() will reposition the buffer pointer to the current position. This provides for a lookahead mechanism where characters may be read, the buffer reset() and the data made available to be read once more.

Overrides:

mark in class Reader

Parameters:

limit - the maximum to be buffered following the mark

Throws:

IOException - with possible error

markSupported

public boolean markSupported()

Indicates whether a stream supports the marking feature.

Overrides:

markSupported in class Reader

Returns:

TRUE always as this class supports mark()

read

public int read()
         throws IOException

Reads a single character. If the readline() method had been previously used and terminated by a carriage return \r this will ignore any following linefeed \n.

Overrides:

read in class Reader

Returns:

the character as an integer or -1 if the end of the stream is reached

Throws:

IOException - with error

read

public int read(char[] arr,
                int ofs,
                int len)
         throws IOException

Reads characters into part of a character array. If readLine() was previously used and terminated by a carriage return \r any following linefeed \n will be ignored.

Specified by:

read in class Reader

Parameters:

arr - the character array to receive data

ofs - position in the character array to be modified

len - maximum number of character to read

Returns:

count read or -1 if the end of the stream is reached

Throws:

IOException - with errors

readLine

public String readLine()
                throws IOException

Returns the next line of text from the stream (blocking). This will return a partial line if the stream runs dry.

Returns:

string with a line of text up to a CR, LF or CRLF termination.

Throws:

IOException - if stream closed

terminated

public boolean terminated()

Indicates if the last readLine() was terminated.

Returns:

TRUE if the previous line save terminated

Since:

v1.5.1

ready

public boolean ready()
              throws IOException

Indicates that there is data ready to be read.

Overrides:

ready in class Reader

Returns:

TRUE if there is unread data in the stream

Throws:

IOException - with any error

reset

public void reset()
           throws IOException

Resets the buffer pointer. If mark() has been called then the buffer pointer is moved back to that position and subsequent data may be reread.

Overrides:

reset in class Reader

Throws:

IOException - if mark() has not been called

skip

public long skip(long len)
          throws IOException

Skips the specified number of characters in the stream (blocking). If readLine() had been previously used and the line terminated with a carriage return \r then any following linefeed \n is ignored and not counted.

Overrides:

skip in class Reader

Parameters:

len - count of characters to skip

Returns:

number of characters skipped.

Throws:

IOException - with any error