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[] b, int off, int len)
Reads compressed data into a byte buffer.
void reset()
This operation is not supported and throws IOException.
long skip(long n)
Skips count number of 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
From class java.io.InputStream
From class java.lang.Object
From interface java.io.Closeable

Fields

protected final byte[] buf

Since: API Level 9

protected final Deflater def

Since: API Level 9

Public Constructors

public DeflaterInputStream (InputStream in)

Since: 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)

Since: 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)

Since: 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 ()

Since: 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 ()

Since: API Level 9

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

Throws
IOException

public void mark (int limit)

Since: 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 ()

Since: 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 ()

Since: 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[] b, int off, int len)

Since: API Level 9

Reads 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.

Parameters
b the byte buffer that compressed data will be read into.
off the offset in the byte buffer where compressed data will start to be read into.
len the length of the compressed data that is expected to read.
Returns
  • the number of bytes read or -1 if the end of the compressed input stream has been reached.
Throws
IOException

public void reset ()

Since: API Level 9

This operation is not supported and throws IOException.

Throws
IOException

public long skip (long n)

Since: API Level 9

Skips count number of bytes in this stream. Subsequent read()'s will not return these bytes unless reset() is used. This implementation skips count number of bytes in the filtered stream.

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

Parameters
n the number of bytes to skip.
Returns
  • the number of bytes actually skipped.
Throws
IOException