DeflaterInputStream - Android SDK

Added in API level 9

public class

DeflaterInputStream

extends FilterInputStream

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

Class Overview

An InputStream filter to compress data. Callers read compressed data in the "deflate" format from the uncompressed underlying stream.

Summary

Fields
protected final byte[]	buf
protected final Deflater	def

[Expand]

Inherited Fields

From class java.io.FilterInputStream

Public Constructors
	DeflaterInputStream(InputStream in) Constructs a `DeflaterInputStream` with a new `Deflater` and an implementation-defined default internal buffer size.
	DeflaterInputStream(InputStream in, Deflater deflater) Constructs a `DeflaterInputStream` with the given `Deflater` and an implementation-defined default internal buffer size.
	DeflaterInputStream(InputStream in, Deflater deflater, int bufferSize) Constructs a `DeflaterInputStream` with the given `Deflater` and given internal buffer size.

Public Methods
int	available() Returns 0 when when this stream has exhausted its input; and 1 otherwise.
void	close() Closes the underlying input stream and discards any remaining uncompressed data.
void	mark(int limit) This operation is not supported and does nothing.
boolean	markSupported() Returns false because `DeflaterInputStream` does not support `mark`/`reset`.
int	read() Reads a byte from the compressed input stream.
int	read(byte[] buffer, int byteOffset, int byteCount) Reads up to `byteCount` bytes of compressed data into a byte buffer.
void	reset() This operation is not supported and throws `IOException`.
long	skip(long byteCount) Skips `byteCount` bytes in this stream. Note: if `n > Integer.MAX_VALUE`, this stream will only attempt to skip `Integer.MAX_VALUE` bytes.

[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 final byte[] buf

Added in API level 9

protected final Deflater def

Added in API level 9

Public Constructors

public DeflaterInputStream (InputStream in)

Added in API level 9

Constructs a DeflaterInputStream with a new Deflater and an implementation-defined default internal buffer size. in is a source of uncompressed data, and this stream will be a source of compressed data.

Parameters

in	the source `InputStream`

public DeflaterInputStream (InputStream in, Deflater deflater)

Added in API level 9

Constructs a DeflaterInputStream with the given Deflater and an implementation-defined default internal buffer size. in is a source of uncompressed data, and this stream will be a source of compressed data.

Parameters

in	the source `InputStream`
deflater	the `Deflater` to be used for compression

public DeflaterInputStream (InputStream in, Deflater deflater, int bufferSize)

Added in API level 9

Constructs a DeflaterInputStream with the given Deflater and given internal buffer size. in is a source of uncompressed data, and this stream will be a source of compressed data.

Parameters

in	the source `InputStream`
deflater	the `Deflater` to be used for compression
bufferSize	the length in bytes of the internal buffer

Public Methods

public int available ()

Added in API level 9

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 9

Closes the underlying input stream and discards any remaining uncompressed data.

Throws

IOException

public void mark (int limit)

Added in API level 9

This operation is not supported and does nothing.

Parameters

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

public boolean markSupported ()

Added in API level 9

Returns false because DeflaterInputStream does not support mark/reset.

Returns

true if mark() and reset() are supported, false otherwise.

public int read ()

Added in API level 9

Reads a byte from the compressed input stream. The result will be a byte of compressed data corresponding to an uncompressed byte or bytes read from the underlying stream.

Returns

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

Throws

IOException

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

Added in API level 9

Reads up to byteCount bytes of compressed data into a byte buffer. The result will be bytes of compressed data corresponding to an uncompressed byte or bytes read from the underlying stream. Returns the number of bytes read or -1 if the end of the compressed input stream has been reached.

Throws

IOException

public void reset ()

Added in API level 9

This operation is not supported and throws IOException.

Throws

IOException

public long skip (long byteCount)

Added in API level 9

Skips byteCount bytes in this stream. Subsequent calls to read will not return these bytes unless reset is used. This implementation skips byteCount bytes in the filtered stream.

Note: if n > Integer.MAX_VALUE, this stream will only attempt to skip Integer.MAX_VALUE bytes.

Returns

the number of bytes actually skipped.

Throws

IOException

Results

Interfaces

Classes

Exceptions

Errors

DeflaterInputStream

Class Overview

Summary

Fields

protected final byte[] buf

protected final Deflater def

Public Constructors

public DeflaterInputStream (InputStream in)

Parameters

public DeflaterInputStream (InputStream in, Deflater deflater)

Parameters

public DeflaterInputStream (InputStream in, Deflater deflater, int bufferSize)

Parameters

Public Methods

public int available ()

Returns

Throws

public void close ()

Throws

public void mark (int limit)

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)

Returns

Throws