InflaterInputStream - Android SDK

Added in API level 1

public class

InflaterInputStream

extends FilterInputStream

java.lang.Object
↳	java.io.InputStream
	↳	java.io.FilterInputStream
		↳	java.util.zip.InflaterInputStream

Known Direct Subclasses

GZIPInputStream, ZipInputStream

Known Indirect Subclasses

JarInputStream

Class Overview

This class provides an implementation of FilterInputStream that decompresses data that was compressed using the DEFLATE algorithm (see specification). Basically it wraps the Inflater class and takes care of the buffering.

Summary

Fields
protected byte[]	buf	The input buffer used for decompression.
protected Inflater	inf	The inflater used for this stream.
protected int	len	The length of the buffer.

[Expand]

Inherited Fields

From class java.io.FilterInputStream

Public Constructors
	InflaterInputStream(InputStream is) This is the most basic constructor.
	InflaterInputStream(InputStream is, Inflater inflater) This constructor lets you pass a specifically initialized Inflater, for example one that expects no ZLIB header.
	InflaterInputStream(InputStream is, Inflater inflater, int bufferSize) This constructor lets you specify both the `Inflater` as well as the internal buffer size to be used.

Public Methods
int	available() Returns 0 when when this stream has exhausted its input; and 1 otherwise.
void	close() Closes the input stream.
void	mark(int readlimit) Marks the current position in the stream.
boolean	markSupported() Returns whether the receiver implements `mark` semantics.
int	read() Reads a single byte of decompressed data.
int	read(byte[] buffer, int byteOffset, int byteCount) Reads up to `byteCount` bytes of decompressed data and stores it in `buffer` starting at `byteOffset`.
void	reset() This operation is not supported and throws `IOException`.
long	skip(long byteCount) Skips up to `byteCount` bytes of uncompressed data.

Protected Methods
void	fill() Fills the input buffer with data to be decompressed.

[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 input buffer used for decompression.

protected Inflater inf

Added in API level 1

The inflater used for this stream.

protected int len

Added in API level 1

The length of the buffer.

Public Constructors

public InflaterInputStream (InputStream is)

Added in API level 1

This is the most basic constructor. You only need to pass the InputStream from which the compressed data is to be read from. Default settings for the Inflater and internal buffer are be used. In particular the Inflater expects a ZLIB header from the input stream.

Parameters

is	the `InputStream` to read data from.

public InflaterInputStream (InputStream is, Inflater inflater)

Added in API level 1

This constructor lets you pass a specifically initialized Inflater, for example one that expects no ZLIB header.

Parameters

is	the `InputStream` to read data from.
inflater	the specific `Inflater` for decompressing data.

public InflaterInputStream (InputStream is, Inflater inflater, int bufferSize)

Added in API level 1

This constructor lets you specify both the Inflater as well as the internal buffer size to be used.

Parameters

is	the `InputStream` to read data from.
inflater	the specific `Inflater` for decompressing data.
bufferSize	the size to be used for the internal buffer.

Public Methods

public int available ()

Added in API level 1

Returns 0 when when this stream has exhausted its input; and 1 otherwise. A result of 1 does not guarantee that further bytes can be returned, with or without blocking.

Although consistent with the RI, this behavior is inconsistent with available(), and violates the Liskov Substitution Principle. This method should not be used.

Returns

0 if no further bytes are available. Otherwise returns 1, which suggests (but does not guarantee) that additional bytes are available.

Throws

IOException	if this stream is closed or an error occurs

public void close ()

Added in API level 1

Closes the input stream.

Throws

IOException	If an error occurs closing the input stream.

public void mark (int readlimit)

Added in API level 1

Marks the current position in the stream. This implementation overrides the super type implementation to do nothing at all.

Parameters

readlimit	of no use.

public boolean markSupported ()

Added in API level 1

Returns whether the receiver implements mark semantics. This type does not support mark(), so always responds false.

Returns

false, always

public int read ()

Added in API level 1

Reads a single byte of decompressed data.

Returns

the byte read.

Throws

IOException	if an error occurs reading the byte.

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

Added in API level 1

Reads up to byteCount bytes of decompressed data and stores it in buffer starting at byteOffset. Returns the number of uncompressed bytes read, or -1.

Throws

IOException

public void reset ()

Added in API level 1

This operation is not supported and throws IOException.

Throws

IOException

public long skip (long byteCount)

Added in API level 1

Skips up to byteCount bytes of uncompressed data.

Parameters

byteCount	the number of bytes to skip.

Returns

the number of uncompressed bytes skipped.

Throws

IllegalArgumentException	if `byteCount < 0`.
IOException	if an error occurs skipping.

Protected Methods

protected void fill ()

Added in API level 1

Fills the input buffer with data to be decompressed.

Throws

IOException	if an `IOException` occurs.

Results

Interfaces

Classes

Exceptions

Errors

InflaterInputStream

Class Overview

See Also

Summary

Fields

protected byte[] buf

protected Inflater inf

protected int len

Public Constructors

public InflaterInputStream (InputStream is)

Parameters

public InflaterInputStream (InputStream is, Inflater inflater)

Parameters

public InflaterInputStream (InputStream is, Inflater inflater, int bufferSize)

Parameters

Public Methods

public int available ()

Returns

Throws

public void close ()

Throws

public void mark (int readlimit)

Parameters

public boolean markSupported ()

Returns

public int read ()

Returns

Throws

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

Throws

public void reset ()

Throws

public long skip (long byteCount)

Parameters

Returns

Throws

Protected Methods

protected void fill ()

Throws