# Base64InputStream
Added in[API level 8](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
Summary:[Inherited Fields](https://developer.android.com/reference/android/util/Base64InputStream#inhfields)\|[Ctors](https://developer.android.com/reference/android/util/Base64InputStream#pubctors)\|[Methods](https://developer.android.com/reference/android/util/Base64InputStream#pubmethods)\|[Inherited Methods](https://developer.android.com/reference/android/util/Base64InputStream#inhmethods)
# Base64InputStream
*** ** * ** ***
[Kotlin](https://developer.android.com/reference/kotlin/android/util/Base64InputStream "View this page in Kotlin")\|Java
`
public
class
Base64InputStream
`
`
``
``
extends `[FilterInputStream](https://developer.android.com/reference/java/io/FilterInputStream)`
``
`
|---|---|---|--------------------------------|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||||
| ↳ | [java.io.InputStream](https://developer.android.com/reference/java/io/InputStream) |||
| | ↳ | [java.io.FilterInputStream](https://developer.android.com/reference/java/io/FilterInputStream) ||
| | | ↳ | android.util.Base64InputStream |
*** ** * ** ***
An InputStream that does Base64 decoding on the data read through it.
## Summary
| ### Inherited fields |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| From class[java.io.FilterInputStream](https://developer.android.com/reference/java/io/FilterInputStream) |-----------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------| | ` protected `[InputStream](https://developer.android.com/reference/java/io/InputStream) | [in](https://developer.android.com/reference/java/io/FilterInputStream#in) The input stream to be filtered. | |
| ### Public constructors ||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|
| ` `[Base64InputStream](https://developer.android.com/reference/android/util/Base64InputStream#Base64InputStream(java.io.InputStream,%20int))`(`[InputStream](https://developer.android.com/reference/java/io/InputStream)` in, int flags) ` An InputStream that performs Base64 decoding on the data read from the wrapped stream. |
| ### Public methods ||
|------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` int` | ` `[available](https://developer.android.com/reference/android/util/Base64InputStream#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://developer.android.com/reference/android/util/Base64InputStream#close())`() ` Closes this input stream and releases any system resources associated with the stream. |
| ` void` | ` `[mark](https://developer.android.com/reference/android/util/Base64InputStream#mark(int))`(int readlimit) ` Marks the current position in this input stream. |
| ` boolean` | ` `[markSupported](https://developer.android.com/reference/android/util/Base64InputStream#markSupported())`() ` Tests if this input stream supports the`mark`and`reset`methods. |
| ` int` | ` `[read](https://developer.android.com/reference/android/util/Base64InputStream#read())`() ` Reads the next byte of data from this input stream. |
| ` int` | ` `[read](https://developer.android.com/reference/android/util/Base64InputStream#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. |
| ` void` | ` `[reset](https://developer.android.com/reference/android/util/Base64InputStream#reset())`() ` Repositions this stream to the position at the time the`mark`method was last called on this input stream. |
| ` long` | ` `[skip](https://developer.android.com/reference/android/util/Base64InputStream#skip(long))`(long n) ` Skips over and discards`n`bytes of data from the input stream. |
| ### Inherited methods |
|-----------------------|---|
| From class` `[java.io.FilterInputStream](https://developer.android.com/reference/java/io/FilterInputStream)` ` |------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` int` | ` `[available](https://developer.android.com/reference/java/io/FilterInputStream#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://developer.android.com/reference/java/io/FilterInputStream#close())`() ` Closes this input stream and releases any system resources associated with the stream. | | ` void` | ` `[mark](https://developer.android.com/reference/java/io/FilterInputStream#mark(int))`(int readlimit) ` Marks the current position in this input stream. | | ` boolean` | ` `[markSupported](https://developer.android.com/reference/java/io/FilterInputStream#markSupported())`() ` Tests if this input stream supports the`mark`and`reset`methods. | | ` int` | ` `[read](https://developer.android.com/reference/java/io/FilterInputStream#read())`() ` Reads the next byte of data from this input stream. | | ` int` | ` `[read](https://developer.android.com/reference/java/io/FilterInputStream#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://developer.android.com/reference/java/io/FilterInputStream#read(byte[]))`(byte[] b) ` Reads up to`b.length`bytes of data from this input stream into an array of bytes. | | ` void` | ` `[reset](https://developer.android.com/reference/java/io/FilterInputStream#reset())`() ` Repositions this stream to the position at the time the`mark`method was last called on this input stream. | | ` long` | ` `[skip](https://developer.android.com/reference/java/io/FilterInputStream#skip(long))`(long n) ` Skips over and discards`n`bytes of data from the input stream. | ||
| From class` `[java.io.InputStream](https://developer.android.com/reference/java/io/InputStream)` ` |--------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` int` | ` `[available](https://developer.android.com/reference/java/io/InputStream#available())`() ` Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking, which may be 0, or 0 when end of stream is detected. | | ` void` | ` `[close](https://developer.android.com/reference/java/io/InputStream#close())`() ` Closes this input stream and releases any system resources associated with the stream. | | ` void` | ` `[mark](https://developer.android.com/reference/java/io/InputStream#mark(int))`(int readlimit) ` Marks the current position in this input stream. | | ` boolean` | ` `[markSupported](https://developer.android.com/reference/java/io/InputStream#markSupported())`() ` Tests if this input stream supports the`mark`and`reset`methods. | | ` static `[InputStream](https://developer.android.com/reference/java/io/InputStream) | ` `[nullInputStream](https://developer.android.com/reference/java/io/InputStream#nullInputStream())`() ` Returns a new`InputStream`that reads no bytes. | | ` int` | ` `[read](https://developer.android.com/reference/java/io/InputStream#read(byte[]))`(byte[] b) ` Reads some number of bytes from the input stream and stores them into the buffer array`b`. | | ` abstract int` | ` `[read](https://developer.android.com/reference/java/io/InputStream#read())`() ` Reads the next byte of data from the input stream. | | ` int` | ` `[read](https://developer.android.com/reference/java/io/InputStream#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. | | ` byte[]` | ` `[readAllBytes](https://developer.android.com/reference/java/io/InputStream#readAllBytes())`() ` Reads all remaining bytes from the input stream. | | ` int` | ` `[readNBytes](https://developer.android.com/reference/java/io/InputStream#readNBytes(byte[],%20int,%20int))`(byte[] b, int off, int len) ` Reads the requested number of bytes from the input stream into the given byte array. | | ` byte[]` | ` `[readNBytes](https://developer.android.com/reference/java/io/InputStream#readNBytes(int))`(int len) ` Reads up to a specified number of bytes from the input stream. | | ` void` | ` `[reset](https://developer.android.com/reference/java/io/InputStream#reset())`() ` Repositions this stream to the position at the time the`mark`method was last called on this input stream. | | ` long` | ` `[skip](https://developer.android.com/reference/java/io/InputStream#skip(long))`(long n) ` Skips over and discards`n`bytes of data from this input stream. | | ` void` | ` `[skipNBytes](https://developer.android.com/reference/java/io/InputStream#skipNBytes(long))`(long n) ` Skips over and discards exactly`n`bytes of data from this input stream. | | ` long` | ` `[transferTo](https://developer.android.com/reference/java/io/InputStream#transferTo(java.io.OutputStream))`(`[OutputStream](https://developer.android.com/reference/java/io/OutputStream)` out) ` Reads all bytes from this input stream and writes the bytes to the given output stream in the order that they are read. | ||
| From class` `[java.lang.Object](https://developer.android.com/reference/java/lang/Object)` ` |--------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` `[Object](https://developer.android.com/reference/java/lang/Object) | ` `[clone](https://developer.android.com/reference/java/lang/Object#clone())`() ` Creates and returns a copy of this object. | | ` boolean` | ` `[equals](https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object))`(`[Object](https://developer.android.com/reference/java/lang/Object)` obj) ` Indicates whether some other object is "equal to" this one. | | ` void` | ` `[finalize](https://developer.android.com/reference/java/lang/Object#finalize())`() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. | | ` final `[Class](https://developer.android.com/reference/java/lang/Class)`` | ` `[getClass](https://developer.android.com/reference/java/lang/Object#getClass())`() ` Returns the runtime class of this`Object`. | | ` int` | ` `[hashCode](https://developer.android.com/reference/java/lang/Object#hashCode())`() ` Returns a hash code value for the object. | | ` final void` | ` `[notify](https://developer.android.com/reference/java/lang/Object#notify())`() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` `[notifyAll](https://developer.android.com/reference/java/lang/Object#notifyAll())`() ` Wakes up all threads that are waiting on this object's monitor. | | ` `[String](https://developer.android.com/reference/java/lang/String) | ` `[toString](https://developer.android.com/reference/java/lang/Object#toString())`() ` Returns a string representation of the object. | | ` final void` | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait(long,%20int))`(long timeoutMillis, int nanos) ` Causes the current thread to wait until it is awakened, typically by being*notified* or*interrupted*, or until a certain amount of real time has elapsed. | | ` final void` | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait(long))`(long timeoutMillis) ` Causes the current thread to wait until it is awakened, typically by being*notified* or*interrupted*, or until a certain amount of real time has elapsed. | | ` final void` | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait())`() ` Causes the current thread to wait until it is awakened, typically by being*notified* or*interrupted*. | ||
| From interface` `[java.io.Closeable](https://developer.android.com/reference/java/io/Closeable)` ` |------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` abstract void` | ` `[close](https://developer.android.com/reference/java/io/Closeable#close())`() ` Closes this stream and releases any system resources associated with it. | ||
| From interface` `[java.lang.AutoCloseable](https://developer.android.com/reference/java/lang/AutoCloseable)` ` |------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------| | ` abstract void` | ` `[close](https://developer.android.com/reference/java/lang/AutoCloseable#close())`() ` Closes this resource, relinquishing any underlying resources. | ||
## Public constructors
### Base64InputStream
Added in[API level 8](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public Base64InputStream (InputStream in,
int flags)
```
An InputStream that performs Base64 decoding on the data read from the wrapped stream.
| Parameters ||
|---------|------------------------------------------------------------------------------------------------------------------------------------------------|
| `in` | `InputStream`: the InputStream to read the source data from
|
| `flags` | `int`: bit flags for controlling the decoder; see the constants in[Base64](https://developer.android.com/reference/android/util/Base64)
|
## Public methods
### available
Added in[API level 8](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public 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 caller of a method for this input stream. The next caller 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 result of[in](https://developer.android.com/reference/java/io/FilterInputStream#in).available().
| Returns ||
|-------|-----------------------------------------------------------------------------------------------------------------------|
| `int` | an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking.
|
### close
Added in[API level 8](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public void close ()
```
Closes this input stream and releases any system resources associated with the stream. This method simply performs`in.close()`.
| Throws ||
|----------------------------------------------------------------------------|---|
| [IOException](https://developer.android.com/reference/java/io/IOException) | |
### mark
Added in[API level 8](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public void mark (int readlimit)
```
Marks the current position in this input stream. A subsequent call to the`reset`method repositions this stream at the last marked position so that subsequent reads re-read the same bytes.
The`readlimit`argument tells this input stream to allow that many bytes to be read before the mark position gets invalidated.
This method simply performs`in.mark(readlimit)`.
| Parameters ||
|-------------|-----------------------------------------------------------------------------------------------------|
| `readlimit` | `int`: the maximum limit of bytes that can be read before the mark position becomes invalid.
|
### markSupported
Added in[API level 8](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public boolean markSupported ()
```
Tests if this input stream supports the`mark`and`reset`methods. This method simply performs`in.markSupported()`.
| Returns ||
|-----------|---------------------------------------------------------------------------------------|
| `boolean` | `true`if this stream type supports the`mark`and`reset`method;`false`otherwise.
|
### read
Added in[API level 8](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public int read ()
```
Reads the next byte of data from this input stream. The value byte is returned as an`int`in the range`0`to`255`. If no byte is available because the end of the stream has been reached, the value`-1`is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.
This method simply performs`in.read()`and returns the result.
| Returns ||
|-------|--------------------------------------------------------------------------|
| `int` | the next byte of data, or`-1`if the end of the stream is reached.
|
| Throws ||
|----------------------------------------------------------------------------|---|
| [IOException](https://developer.android.com/reference/java/io/IOException) | |
### read
Added in[API level 8](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public int read (byte[] b,
int off,
int len)
```
Reads up to`len`bytes of data from this input stream into an array of bytes. If`len`is not zero, the method blocks until some input is available; otherwise, no bytes are read and`0`is returned.
This method simply performs`in.read(b, off, len)`and returns the result.
| Parameters ||
|-------|------------------------------------------------------------|
| `b` | `byte`: the buffer into which the data is read.
|
| `off` | `int`: the start offset in the destination array`b`
|
| `len` | `int`: the maximum number of bytes read.
|
| Returns ||
|-------|---------------------------------------------------------------------------------------------------------------------------------------|
| `int` | the total number of bytes read into the buffer, or`-1`if there is no more data because the end of the stream has been reached.
|
| Throws ||
|----------------------------------------------------------------------------|---|
| [IOException](https://developer.android.com/reference/java/io/IOException) | |
### reset
Added in[API level 8](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public void reset ()
```
Repositions this stream to the position at the time the`mark`method was last called on this input stream.
This method simply performs`in.reset()`.
Stream marks are intended to be used in situations where you need to read ahead a little to see what's in the stream. Often this is most easily done by invoking some general parser. If the stream is of the type handled by the parse, it just chugs along happily. If the stream is not of that type, the parser should toss an exception when it fails. If this happens within readlimit bytes, it allows the outer code to reset the stream and try another parser.
### skip
Added in[API level 8](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public long skip (long n)
```
Skips over and discards`n`bytes of data from the input stream. The`skip`method may, for a variety of reasons, end up skipping over some smaller number of bytes, possibly`0`. The actual number of bytes skipped is returned.
This method simply performs`in.skip(n)`.
| Parameters ||
|-----|---------------------------------------------------|
| `n` | `long`: the number of bytes to be skipped.
|
| Returns ||
|--------|--------------------------------------------|
| `long` | the actual number of bytes skipped.
|
| Throws ||
|----------------------------------------------------------------------------|---|
| [IOException](https://developer.android.com/reference/java/io/IOException) | |