BufferedInputStream - Android SDK

Added in API level 1

public class

BufferedInputStream

extends FilterInputStream

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

Class Overview

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"));

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`.

[Expand]

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
synchronized int	available() Returns an estimated number of bytes that can be read or skipped without blocking for more input.
void	close() Closes this stream.
synchronized void	mark(int readlimit) Sets a mark position in this stream.
boolean	markSupported() Indicates whether `BufferedInputStream` supports the `mark()` and `reset()` methods.
synchronized int	read() Reads a single byte from this stream and returns it as an integer in the range from 0 to 255.
synchronized 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`.
synchronized void	reset() Resets this stream to the last marked location.
synchronized long	skip(long byteCount) Skips `byteCount` bytes in this stream.

[Expand]

Inherited Methods

From class java.io.FilterInputStream

int	available() Returns an estimated number of bytes that can be read or skipped without blocking for more input.
void	close() Closes this stream.
synchronized void	mark(int readlimit) Sets a mark position in this stream.
boolean	markSupported() Indicates whether this stream supports `mark()` and `reset()`.
int	read() Reads a single byte from the filtered 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`.
synchronized void	reset() Resets this stream to the last marked location.
long	skip(long byteCount) Skips `byteCount` bytes in this stream.

From class java.io.InputStream

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 InputStream.
boolean	markSupported() Indicates whether this stream supports the `mark()` and `reset()` methods.
int	read(byte[] buffer) Equivalent to `read(buffer, 0, buffer.length)`.
abstract 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`.
synchronized void	reset() Resets this stream to the last marked location.
long	skip(long byteCount) Skips at most `byteCount` bytes in this stream.

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

From interface java.io.Closeable

From interface java.lang.AutoCloseable

Fields

protected byte[] buf

Added in API level 1

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

protected int count

Added in API level 1

The total number of bytes inside the byte array buf.

protected int marklimit

Added in API level 1

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

protected int markpos

Added in API level 1

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

protected int pos

Added in API level 1

The current position within the byte array buf.

Public Constructors

public BufferedInputStream (InputStream in)

Added in API level 1

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	the `InputStream` the buffer reads from.

public BufferedInputStream (InputStream in, int size)

Added in API level 1

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	the `InputStream` the buffer reads from.
size	the size of buffer in bytes.

Throws

IllegalArgumentException	if `size <= 0`.

Public Methods

public synchronized int available ()

Added in API level 1

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

the estimated number of bytes available

Throws

IOException	if this stream is closed or an error occurs

public void close ()

Added in API level 1

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.

public synchronized void mark (int readlimit)

Added in API level 1

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	the number of bytes that can be read before the mark is invalidated.

public boolean markSupported ()

Added in API level 1

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

Returns

true for BufferedInputStreams.

public synchronized int read ()

Added in API level 1

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

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.

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

Added in API level 1

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.

Throws

IOException

public synchronized void reset ()

Added in API level 1

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.

public synchronized long skip (long byteCount)

Added in API level 1

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

Parameters

byteCount	the number of bytes to skip. `skip` does nothing and returns 0 if `byteCount` is less than zero.

Returns

the number of bytes actually skipped.

Throws

IOException	if this stream is closed or another IOException occurs.

Results

Interfaces

Classes

Exceptions

Errors

BufferedInputStream

Class Overview

See Also

Summary

Fields

protected byte[] buf

protected int count

protected int marklimit

protected int markpos

protected int pos

Public Constructors

public BufferedInputStream (InputStream in)

Parameters

public BufferedInputStream (InputStream in, int size)

Parameters

Throws

Public Methods

public synchronized int available ()

Returns

Throws

public void close ()

Throws

public synchronized void mark (int readlimit)

Parameters

See Also

public boolean markSupported ()

Returns

See Also

public synchronized int read ()

Returns

Throws

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

Throws

public synchronized void reset ()

Throws

See Also

public synchronized long skip (long byteCount)

Parameters

Returns

Throws