Summary: Ctors | Methods | Inherited Methods | [Expand All]

public abstract class

InputStream

extends Object
implements Closeable

java.lang.Object
↳	java.io.InputStream

Known Direct Subclasses

AssetManager.AssetInputStream, ByteArrayInputStream, ChunkedInputStream, ContentLengthInputStream, EofSensorInputStream, FileInputStream, FilterInputStream, IdentityInputStream, ObjectInputStream, PipedInputStream, SequenceInputStream, StringBufferInputStream

Known Indirect Subclasses

AssetFileDescriptor.AutoCloseInputStream, BufferedInputStream, CheckedInputStream, CipherInputStream, DataInputStream, DigestInputStream, GZIPInputStream, InflaterInputStream, JarInputStream, LineNumberInputStream, ParcelFileDescriptor.AutoCloseInputStream, PushbackInputStream, ZipInputStream

AssetFileDescriptor.AutoCloseInputStream	An InputStream you can create on a ParcelFileDescriptor, which will take care of calling `ParcelFileDescritor.close()` for you when the stream is closed.
BufferedInputStream	Wraps an existing `InputStream` and buffers the input.
CheckedInputStream	The `CheckedInputStream` class is used to maintain a checksum at the same time as the data, on which the checksum is computed, is read from a stream.
CipherInputStream	This class wraps an `InputStream` and a cipher so that `read()` methods return data that are read from the underlying `InputStream` and processed by the cipher.
DataInputStream	Wraps an existing `InputStream` and reads typed data from it.
DigestInputStream	`DigestInputStream` is a `FilterInputStream` which maintains an associated message digest.
GZIPInputStream	The `GZIPInputStream` class is used to read data stored in the GZIP format, reading and decompressing GZIP data from the underlying stream into its buffer.
InflaterInputStream	This class provides an implementation of `FilterInputStream` that uncompresses data that was compressed using the DEFLATE algorithm (see specification).
JarInputStream	The input stream from which the JAR file to be read may be fetched.
LineNumberInputStream	This class is deprecated. Use `LineNumberReader`
ParcelFileDescriptor.AutoCloseInputStream	An InputStream you can create on a ParcelFileDescriptor, which will take care of calling `ParcelFileDescritor.close()` for you when the stream is closed.
PushbackInputStream	Wraps an existing `InputStream` and adds functionality to "push back" bytes that have been read, so that they can be read again.
ZipInputStream	This class provides an implementation of `FilterInputStream` that uncompresses data from a ZIP-archive input stream.

Class Overview

The base class for all input streams. An input stream is a means of reading data from a source in a byte-wise manner.

Some input streams also support marking a position in the input stream and returning to this position later. This abstract class does not provide a fully working implementation, so it needs to be subclassed, and at least the read() method needs to be overridden. Overriding some of the non-abstract methods is also often advised, since it might result in higher efficiency.

Many specialized input streams for purposes like reading from a file already exist in this package.

Summary

Public Constructors
	InputStream() This constructor does nothing.

Public Methods
int	available() Returns the number of bytes that are available before this stream will block.
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[] b, int offset, int length) Reads at most `length` bytes from this stream and stores them in the byte array `b` starting at `offset`.
int	read(byte[] b) Reads bytes from this stream and stores them in the byte array `b`.
abstract int	read() Reads a single byte from this stream and returns it as an integer in the range from 0 to 255.
synchronized void	reset() Resets this stream to the last marked location.
long	skip(long n) Skips at most `n` bytes in this stream.

[Expand]

Inherited Methods

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() Is called before the object's memory is being reclaimed by the VM.
final Class<? extends Object>	getClass() Returns the unique instance of `Class` which 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(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.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.

From interface java.io.Closeable

Public Constructors

public InputStream ()

Since: API Level 1

This constructor does nothing. It is provided for signature compatibility.

Public Methods

public int available ()

Since: API Level 1

Returns the number of bytes that are available before this stream will block. This implementation always returns 0. Subclasses should override and indicate the correct number of bytes available.

Returns

the number of bytes available before blocking.

Throws

IOException	if an error occurs in this stream.

public void close ()

Since: API Level 1

Closes this stream. Concrete implementations of this class should free any resources during close. This implementation does nothing.

Throws

IOException	if an error occurs while closing this stream.

public void mark (int readlimit)

Since: API Level 1

Sets a mark position in this InputStream. The parameter readlimit indicates how many bytes can be read before the mark is invalidated. Sending reset() will reposition the stream back to the marked position provided readLimit has not been surpassed.

This default implementation does nothing and concrete subclasses must provide their own implementation.

Parameters

readlimit	the number of bytes that can be read from this stream before the mark is invalidated.

public boolean markSupported ()

Since: API Level 1

Indicates whether this stream supports the mark() and reset() methods. The default implementation returns false.

Returns

always false.

public int read (byte[] b, int offset, int length)

Since: API Level 1

Reads at most length bytes from this stream and stores them in the byte array b starting at offset.

Parameters

b	the byte array in which to store the bytes read.
offset	the initial position in `buffer` to store the bytes read from this stream.
length	the maximum number of bytes to store in `b`.

Returns

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

Throws

IndexOutOfBoundsException	if `offset < 0` or `length < 0`, or if `offset + length` is greater than the length of `b`.
IOException	if the stream is closed or another IOException occurs.

public int read (byte[] b)

Since: API Level 1

Reads bytes from this stream and stores them in the byte array b.

Parameters

b	the byte array in which to store the bytes read.

Returns

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

Throws

IOException	if this stream is closed or another IOException occurs.

public abstract int read ()

Since: 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 stream has been reached. Blocks until one byte has been read, the end of the source stream is detected or an exception is thrown.

Returns

the byte read or -1 if the end of stream has been reached.

Throws

IOException	if the stream is closed or another IOException occurs.

public synchronized void reset ()

Since: API Level 1

Resets this stream to the last marked location. Throws an IOException if the number of bytes read since the mark has been set is greater than the limit provided to mark, or if no mark has been set.

This implementation always throws an IOException and concrete subclasses should provide the proper implementation.

Throws

IOException	if this stream is closed or another IOException occurs.

public long skip (long n)

Since: API Level 1

Skips at most n bytes in this stream. It does nothing and returns 0 if n is negative. Less than n characters are skipped if the end of this stream is reached before the operation completes.

This default implementation reads n bytes into a temporary buffer. Concrete subclasses should provide their own implementation.

Parameters

n	the number of bytes to skip.

Returns

the number of bytes actually skipped.

Throws

IOException	if this stream is closed or another IOException occurs.

Interfaces

Classes

Exceptions

InputStream

Class Overview

See Also

Summary

Public Constructors

public InputStream ()

Public Methods

public int available ()

Returns

Throws

public void close ()

Throws

public void mark (int readlimit)

Parameters

See Also

public boolean markSupported ()

Returns

See Also

public int read (byte[] b, int offset, int length)

Parameters

Returns

Throws

public int read (byte[] b)

Parameters

Returns

Throws

public abstract int read ()

Returns

Throws

public synchronized void reset ()

Throws

public long skip (long n)

Parameters

Returns

Throws