Skip to content

Most visited

Recently visited

navigation
Added in API level 1

BufferedInputStream

public class BufferedInputStream
extends FilterInputStream

java.lang.Object
   ↳ java.io.InputStream
     ↳ java.io.FilterInputStream
       ↳ java.io.BufferedInputStream


Wraps an existing InputStream and buffers the input. Expensive interaction with the underlying input stream is minimized, since most (smaller) requests can be satisfied by accessing the buffer alone. The drawback is that some extra space is required to hold the buffer and that copying takes place when filling that buffer, but this is usually outweighed by the performance benefits.

A typical application pattern for the class looks like this:

 BufferedInputStream buf = new BufferedInputStream(new FileInputStream("file.java"));
 

See also:

Summary

Fields

protected byte[] buf

The buffer containing the current bytes read from the target InputStream.

protected int count

The total number of bytes inside the byte array buf.

protected int marklimit

The current limit, which when passed, invalidates the current mark.

protected int markpos

The currently marked position.

protected int pos

The current position within the byte array buf.

Inherited fields

From class java.io.FilterInputStream

Public constructors

BufferedInputStream(InputStream in)

Constructs a new BufferedInputStream, providing in with a buffer of 8192 bytes.

BufferedInputStream(InputStream in, int size)

Constructs a new BufferedInputStream, providing in with size bytes of buffer.

Public methods

int available()

Returns an estimated number of bytes that can be read or skipped without blocking for more input.

void close()

Closes this stream.

void mark(int readlimit)

Sets a mark position in this stream.

boolean markSupported()

Indicates whether BufferedInputStream supports the mark() and reset() methods.

int read()

Reads a single byte from this stream and returns it as an integer in the range from 0 to 255.

int read(byte[] buffer, int byteOffset, int byteCount)

Reads up to byteCount bytes from this stream and stores them in the byte array buffer starting at byteOffset.

void reset()

Resets this stream to the last marked location.

long skip(long byteCount)

Skips byteCount bytes in this stream.

Inherited methods

From class java.io.FilterInputStream
From class java.io.InputStream
From class java.lang.Object
From interface java.io.Closeable
From interface java.lang.AutoCloseable

Fields

buf

Added in API level 1
byte[] buf

The buffer containing the current bytes read from the target InputStream.

count

Added in API level 1
int count

The total number of bytes inside the byte array buf.

marklimit

Added in API level 1
int marklimit

The current limit, which when passed, invalidates the current mark.

markpos

Added in API level 1
int markpos

The currently marked position. -1 indicates no mark has been set or the mark has been invalidated.

pos

Added in API level 1
int pos

The current position within the byte array buf.

Public constructors

BufferedInputStream

Added in API level 1
BufferedInputStream (InputStream in)

Constructs a new BufferedInputStream, providing in with a buffer of 8192 bytes.

Warning: passing a null source creates a closed BufferedInputStream. All read operations on such a stream will fail with an IOException.

Parameters
in InputStream: the InputStream the buffer reads from.

BufferedInputStream

Added in API level 1
BufferedInputStream (InputStream in, 
                int size)

Constructs a new BufferedInputStream, providing in with size bytes of buffer.

Warning: passing a null source creates a closed BufferedInputStream. All read operations on such a stream will fail with an IOException.

Parameters
in InputStream: the InputStream the buffer reads from.
size int: the size of buffer in bytes.
Throws
IllegalArgumentException if size <= 0.

Public methods

available

Added in API level 1
int available ()

Returns an estimated number of bytes that can be read or skipped without blocking for more input. This method returns the number of bytes available in the buffer plus those available in the source stream, but see available() for important caveats.

Returns
int the estimated number of bytes available
Throws
IOException if this stream is closed or an error occurs

close

Added in API level 1
void close ()

Closes this stream. The source stream is closed and any resources associated with it are released.

Throws
IOException if an error occurs while closing this stream.

mark

Added in API level 1
void mark (int readlimit)

Sets a mark position in this stream. The parameter readlimit indicates how many bytes can be read before a mark is invalidated. Calling reset() will reposition the stream back to the marked position if readlimit has not been surpassed. The underlying buffer may be increased in size to allow readlimit number of bytes to be supported.

Parameters
readlimit int: the number of bytes that can be read before the mark is invalidated.

See also:

markSupported

Added in API level 1
boolean markSupported ()

Indicates whether BufferedInputStream supports the mark() and reset() methods.

Returns
boolean true for BufferedInputStreams.

See also:

read

Added in API level 1
int read ()

Reads a single byte from this stream and returns it as an integer in the range from 0 to 255. Returns -1 if the end of the source string has been reached. If the internal buffer does not contain any available bytes then it is filled from the source stream and the first byte is returned.

Returns
int the byte read or -1 if the end of the source stream has been reached.
Throws
IOException if this stream is closed or another IOException occurs.

read

Added in API level 1
int read (byte[] buffer, 
                int byteOffset, 
                int byteCount)

Reads up to byteCount bytes from this stream and stores them in the byte array buffer starting at byteOffset. Returns the number of bytes actually read or -1 if the end of the stream has been reached.

Parameters
buffer byte
byteOffset int
byteCount int
Returns
int
Throws
IOException

reset

Added in API level 1
void reset ()

Resets this stream to the last marked location.

Throws
IOException if this stream is closed, no mark has been set or the mark is no longer valid because more than readlimit bytes have been read since setting the mark.

See also:

skip

Added in API level 1
long skip (long byteCount)

Skips byteCount bytes in this stream. Subsequent calls to read will not return these bytes unless reset is used.

Parameters
byteCount long: the number of bytes to skip. skip does nothing and returns 0 if byteCount is less than zero.
Returns
long the number of bytes actually skipped.
Throws
IOException if this stream is closed or another IOException occurs.
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.