# BufferedInputStream

public class **BufferedInputStream** extends [FilterInputStream](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/FilterInputStream.html)  
A `BufferedInputStream` adds
functionality to another input stream-namely,
the ability to buffer the input and to
support the `mark` and `reset`
methods. When the `BufferedInputStream`
is created, an internal buffer array is
created. As bytes from the stream are read
or skipped, the internal buffer is refilled
as necessary from the contained input stream,
many bytes at a time. The `mark`
operation remembers a point in the input
stream and the `reset` operation
causes all the bytes read since the most
recent `mark` operation to be
reread before new bytes are taken from
the contained input stream.

### Field Summary

|---|---|---|
| protected byte\[\] | [buf](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/BufferedInputStream.html#buf) | The internal buffer array where the data is stored. |
| protected int | [count](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/BufferedInputStream.html#count) | The index one greater than the index of the last valid byte in the buffer. |
| protected int | [marklimit](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/BufferedInputStream.html#marklimit) | The maximum read ahead allowed after a call to the `mark` method before subsequent calls to the `reset` method fail. |
| protected int | [markpos](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/BufferedInputStream.html#markpos) | The value of the `pos` field at the time the last `mark` method was called. |
| protected int | [pos](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/BufferedInputStream.html#pos) | The current position in the buffer. |

### Inherited Field Summary

From class [java.io.FilterInputStream](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/FilterInputStream.html)

|---|---|---|
| protected [InputStream](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/InputStream.html) | [in](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/FilterInputStream.html#in) | The input stream to be filtered. |

### Public Constructor Summary

|---|---|
|   | [BufferedInputStream](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/BufferedInputStream.html#BufferedInputStream(java.io.InputStream))([InputStream](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/InputStream.html) in) Creates a `BufferedInputStream` and saves its argument, the input stream `in`, for later use. |
|   | [BufferedInputStream](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/BufferedInputStream.html#BufferedInputStream(java.io.InputStream,%20int))([InputStream](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/InputStream.html) in, int size) Creates a `BufferedInputStream` with the specified buffer size, and saves its argument, the input stream `in`, for later use. |

### Public Method Summary

|---|---|
| synchronized int | [available](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/BufferedInputStream.html#available())() Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking by the next invocation of a method for this input stream. |
| void | [close](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/BufferedInputStream.html#close())() Closes this input stream and releases any system resources associated with the stream. |
| synchronized void | [mark](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/BufferedInputStream.html#mark(int))(int readlimit) See the general contract of the `mark` method of `InputStream`. |
| boolean | [markSupported](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/BufferedInputStream.html#markSupported())() Tests if this input stream supports the `mark` and `reset` methods. |
| synchronized int | [read](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/BufferedInputStream.html#read())() See the general contract of the `read` method of `InputStream`. |
| synchronized int | [read](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/BufferedInputStream.html#read(byte[],%20int,%20int))(byte\[\] b, int off, int len) Reads bytes from this byte-input stream into the specified byte array, starting at the given offset. |
| synchronized void | [reset](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/BufferedInputStream.html#reset())() See the general contract of the `reset` method of `InputStream`. |
| synchronized long | [skip](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/BufferedInputStream.html#skip(long))(long n) See the general contract of the `skip` method of `InputStream`. |

### Inherited Method Summary

From class [java.io.FilterInputStream](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/FilterInputStream.html)

|---|---|
| int | [available](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/FilterInputStream.html#available())() Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking by the next caller of a method for this input stream. |
| void | [close](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/FilterInputStream.html#close())() Closes this input stream and releases any system resources associated with the stream. |
| synchronized void | [mark](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/FilterInputStream.html#mark(int))(int readlimit) Marks the current position in this input stream. |
| boolean | [markSupported](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/FilterInputStream.html#markSupported())() Tests if this input stream supports the `mark` and `reset` methods. |
| int | [read](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/FilterInputStream.html#read())() Reads the next byte of data from this input stream. |
| int | [read](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/FilterInputStream.html#read(byte[],%20int,%20int))(byte\[\] b, int off, int len) Reads up to `len` bytes of data from this input stream into an array of bytes. |
| int | [read](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/FilterInputStream.html#read(byte[]))(byte\[\] b) Reads up to `byte.length` bytes of data from this input stream into an array of bytes. |
| synchronized void | [reset](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/FilterInputStream.html#reset())() Repositions this stream to the position at the time the `mark` method was last called on this input stream. |
| long | [skip](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/FilterInputStream.html#skip(long))(long n) Skips over and discards `n` bytes of data from the input stream. |

From class [java.io.InputStream](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/InputStream.html)

|---|---|
| int | [available](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/InputStream.html#available())() Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking by the next invocation of a method for this input stream. |
| void | [close](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/InputStream.html#close())() Closes this input stream and releases any system resources associated with the stream. |
| synchronized void | [mark](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/InputStream.html#mark(int))(int readlimit) Marks the current position in this input stream. |
| boolean | [markSupported](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/InputStream.html#markSupported())() Tests if this input stream supports the `mark` and `reset` methods. |
| abstract int | [read](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/InputStream.html#read())() Reads the next byte of data from the input stream. |
| int | [read](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/InputStream.html#read(byte[],%20int,%20int))(byte\[\] b, int off, int len) Reads up to `len` bytes of data from the input stream into an array of bytes. |
| int | [read](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/InputStream.html#read(byte[]))(byte\[\] b) Reads some number of bytes from the input stream and stores them into the buffer array `b`. |
| synchronized void | [reset](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/InputStream.html#reset())() Repositions this stream to the position at the time the `mark` method was last called on this input stream. |
| long | [skip](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/InputStream.html#skip(long))(long n) Skips over and discards `n` bytes of data from this input stream. |

From class [java.lang.Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html)

|---|---|
| [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) | [clone](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#clone())() Creates and returns a copy of this `Object`. |
| boolean | [equals](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#equals(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) obj) Compares this instance with the specified object and indicates if they are equal. |
| void | [finalize](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#finalize())() Invoked when the garbage collector has detected that this instance is no longer reachable. |
| final [Class](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Class.html)\<?\> | [getClass](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#getClass())() Returns the unique instance of `https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Class.html` that represents this object's class. |
| int | [hashCode](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#hashCode())() Returns an integer hash code for this object. |
| final void | [notify](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#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](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#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](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [toString](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#toString())() Returns a string containing a concise, human-readable description of this object. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait(long,%20int))(long timeout, 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](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait(long))(long timeout) 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](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait())() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object. |

From interface [java.io.Closeable](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Closeable.html)

|---|---|
| abstract void | [close](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Closeable.html#close())() Closes this stream and releases any system resources associated with it. |

From interface [java.lang.AutoCloseable](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/AutoCloseable.html)

|---|---|
| abstract void | [close](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/AutoCloseable.html#close())() Closes this resource, relinquishing any underlying resources. |

## Fields

#### protected byte\[\]
**buf**

The internal buffer array where the data is stored. When necessary,
it may be replaced by another array of
a different size.

#### protected int
**count**

The index one greater than the index of the last valid byte in
the buffer.
This value is always
in the range `0` through `buf.length`;
elements `buf[0]` through `buf[count-1]
`contain buffered input data obtained
from the underlying input stream.

#### protected int
**marklimit**

The maximum read ahead allowed after a call to the
`mark` method before subsequent calls to the
`reset` method fail.
Whenever the difference between `pos`
and `markpos` exceeds `marklimit`,
then the mark may be dropped by setting
`markpos` to `-1`.

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/io/BufferedInputStream.html#mark(int)`
- `https://developers.google.com/j2objc/javadoc/jre/reference/java/io/BufferedInputStream.html#reset()`

#### protected int
**markpos**

The value of the `pos` field at the time the last
`mark` method was called.


This value is always
in the range `-1` through `pos`.
If there is no marked position in the input
stream, this field is `-1`. If
there is a marked position in the input
stream, then `buf[markpos]`
is the first byte to be supplied as input
after a `reset` operation. If
`markpos` is not `-1`,
then all bytes from positions `buf[markpos]`
through `buf[pos-1]` must remain
in the buffer array (though they may be
moved to another place in the buffer array,
with suitable adjustments to the values
of `count`, `pos`,
and `markpos`); they may not
be discarded unless and until the difference
between `pos` and `markpos`
exceeds `marklimit`.

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/io/BufferedInputStream.html#mark(int)`
- `https://developers.google.com/j2objc/javadoc/jre/reference/java/io/BufferedInputStream.html#pos`

#### protected int
**pos**

The current position in the buffer. This is the index of the next
character to be read from the `buf` array.


This value is always in the range `0`
through `count`. If it is less
than `count`, then `buf[pos]`
is the next byte to be supplied as input;
if it is equal to `count`, then
the next `read` or `skip`
operation will require more bytes to be
read from the contained input stream.

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/io/BufferedInputStream.html#buf`

## Public Constructors

#### public
**BufferedInputStream**
([InputStream](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/InputStream.html) in)

Creates a `BufferedInputStream`
and saves its argument, the input stream
`in`, for later use. An internal
buffer array is created and stored in `buf`.

##### Parameters

| in | the underlying input stream. |
|---|---|

#### public
**BufferedInputStream**
([InputStream](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/InputStream.html) in, int size)

Creates a `BufferedInputStream`
with the specified buffer size,
and saves its argument, the input stream
`in`, for later use. An internal
buffer array of length `size`
is created and stored in `buf`.

##### Parameters

| in | the underlying input stream. |
| size | the buffer size. |
|---|---|

##### Throws

| [IllegalArgumentException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/IllegalArgumentException.html) | if `size <= 0`. |
|---|---|

## Public Methods

#### public synchronized int
**available**
()

Returns an estimate of the number of bytes that can be read (or
skipped over) from this input stream without blocking by the next
invocation of a method for this input stream. The next invocation might be
the same thread or another thread. A single read or skip of this
many bytes will not block, but may read or skip fewer bytes.


This method returns the sum of the number of bytes remaining to be read in
the buffer (`count - pos`) and the result of calling the
`https://developers.google.com/j2objc/javadoc/jre/reference/java/io/FilterInputStream.html#in`.available().

##### Returns

- an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking.

##### Throws

| [IOException](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/IOException.html) | if this input stream has been closed by invoking its `https://developers.google.com/j2objc/javadoc/jre/reference/java/io/BufferedInputStream.html#close()` method, or an I/O error occurs. |
|---|---|

#### public void
**close**
()

Closes this input stream and releases any system resources
associated with the stream.
Once the stream has been closed, further read(), available(), reset(),
or skip() invocations will throw an IOException.
Closing a previously closed stream has no effect.

##### Throws

| [IOException](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/IOException.html) | if an I/O error occurs. |
|---|---|

#### public synchronized void
**mark**
(int readlimit)

See the general contract of the `mark`
method of `InputStream`.

##### Parameters

| readlimit | the maximum limit of bytes that can be read before the mark position becomes invalid. |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/io/BufferedInputStream.html#reset()`

#### public boolean
**markSupported**
()

Tests if this input stream supports the `mark`
and `reset` methods. The `markSupported`
method of `BufferedInputStream` returns
`true`.

##### Returns

- a `boolean` indicating if this stream type supports the `mark` and `reset` methods.

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/io/InputStream.html#mark(int)`
- `https://developers.google.com/j2objc/javadoc/jre/reference/java/io/InputStream.html#reset()`

#### public synchronized int
**read**
()

See
the general contract of the `read`
method of `InputStream`.

##### Returns

- the next byte of data, or `-1` if the end of the stream is reached.

##### Throws

| [IOException](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/IOException.html) | if this input stream has been closed by invoking its `https://developers.google.com/j2objc/javadoc/jre/reference/java/io/BufferedInputStream.html#close()` method, or an I/O error occurs. |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/io/FilterInputStream.html#in`

#### public synchronized int
**read**
(byte\[\] b, int off, int len)

Reads bytes from this byte-input stream into the specified byte array,
starting at the given offset.

This method implements the general contract of the corresponding
`` `https://developers.google.com/j2objc/javadoc/jre/reference/java/io/InputStream.html#read(byte[],%20int,%20int)` `` method of
the `` `https://developers.google.com/j2objc/javadoc/jre/reference/java/io/InputStream.html` `` class. As an additional
convenience, it attempts to read as many bytes as possible by repeatedly
invoking the `read` method of the underlying stream. This
iterated `read` continues until one of the following
conditions becomes true:

- The specified number of bytes have been read,
- The `read` method of the underlying stream returns `-1`, indicating end-of-file, or
- The `available` method of the underlying stream returns zero, indicating that further input requests would block.

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 bytes actually read.

Subclasses of this class are encouraged, but not required, to
attempt to read as many bytes as possible in the same fashion.

##### Parameters

| b | destination buffer. |
| off | offset at which to start storing bytes. |
| len | maximum number of bytes to read. |
|---|---|

##### Returns

- the number of bytes read, or `-1` if the end of the stream has been reached.

##### Throws

| [IOException](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/IOException.html) | if this input stream has been closed by invoking its `https://developers.google.com/j2objc/javadoc/jre/reference/java/io/BufferedInputStream.html#close()` method, or an I/O error occurs. |
|---|---|

#### public synchronized void
**reset**
()

See the general contract of the `reset`
method of `InputStream`.


If `markpos` is `-1`
(no mark has been set or the mark has been
invalidated), an `IOException`
is thrown. Otherwise, `pos` is
set equal to `markpos`.

##### Throws

| [IOException](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/IOException.html) | if this stream has not been marked or, if the mark has been invalidated, or the stream has been closed by invoking its `https://developers.google.com/j2objc/javadoc/jre/reference/java/io/BufferedInputStream.html#close()` method, or an I/O error occurs. |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/io/BufferedInputStream.html#mark(int)`

#### public synchronized long
**skip**
(long n)

See the general contract of the `skip`
method of `InputStream`.

##### Parameters

| n | the number of bytes to be skipped. |
|---|---|

##### Returns

- the actual number of bytes skipped.

##### Throws

| [IOException](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/IOException.html) | if the stream does not support seek, or if this input stream has been closed by invoking its `https://developers.google.com/j2objc/javadoc/jre/reference/java/io/BufferedInputStream.html#close()` method, or an I/O error occurs. |
|---|---|