InflaterInputStream (Java 2 Platform SE 5.0) (original) (raw)

java.util.zip

Class InflaterInputStream

java.lang.Object extended by java.io.InputStream java.io.FilterInputStream java.util.zip.InflaterInputStream

All Implemented Interfaces:

Closeable

Direct Known Subclasses:

GZIPInputStream, ZipInputStream

public class InflaterInputStream

extends FilterInputStream

This class implements a stream filter for uncompressing data in the "deflate" compression format. It is also used as the basis for other decompression filters, such as GZIPInputStream.

See Also:

Inflater

Field Summary
protected byte[]	buf Input buffer for decompression.
protected Inflater	inf Decompressor for this stream.
protected int	len Length of input buffer.

Fields inherited from class java.io.FilterInputStream
in

Constructor Summary
InflaterInputStream(InputStream in) Creates a new input stream with a default decompressor and buffer size.
[InflaterInputStream](../../../java/util/zip/InflaterInputStream.html#InflaterInputStream%28java.io.InputStream, java.util.zip.Inflater%29)(InputStream in,Inflater inf) Creates a new input stream with the specified decompressor and a default buffer size.
[InflaterInputStream](../../../java/util/zip/InflaterInputStream.html#InflaterInputStream%28java.io.InputStream, java.util.zip.Inflater, int%29)(InputStream in,Inflater inf, int size) Creates a new input stream with the specified decompressor and buffer size.

Method Summary
int	available() Returns 0 after EOF has been reached, otherwise always return 1.
void	close() Closes this input stream and releases any system resources associated with the stream.
protected void	fill() Fills input buffer with more data to decompress.
void	mark(int readlimit) Marks the current position in this input stream.
boolean	markSupported() Tests if this input stream supports the mark andreset methods.
int	read() Reads a byte of uncompressed data.
int	[read](../../../java/util/zip/InflaterInputStream.html#read%28byte[], int, int%29)(byte[] b, int off, int len) Reads uncompressed data into an array of bytes.
void	reset() Repositions this stream to the position at the time themark method was last called on this input stream.
long	skip(long n) Skips specified number of bytes of uncompressed data.

Methods inherited from class java.io.FilterInputStream
read

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, [wait](../../../java/lang/Object.html#wait%28long, int%29)

Field Detail

inf

protected Inflater inf

Decompressor for this stream.

buf

protected byte[] buf

Input buffer for decompression.

len

protected int len

Length of input buffer.

Constructor Detail

InflaterInputStream

public InflaterInputStream(InputStream in, Inflater inf, int size)

Creates a new input stream with the specified decompressor and buffer size.

Parameters:

in - the input stream

inf - the decompressor ("inflater")

size - the input buffer size

Throws:

[IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang") - if size is <= 0

InflaterInputStream

public InflaterInputStream(InputStream in, Inflater inf)

Creates a new input stream with the specified decompressor and a default buffer size.

Parameters:

in - the input stream

inf - the decompressor ("inflater")

InflaterInputStream

public InflaterInputStream(InputStream in)

Creates a new input stream with a default decompressor and buffer size.

Parameters:

in - the input stream

Method Detail

read

public int read() throws IOException

Reads a byte of uncompressed data. This method will block until enough input is available for decompression.

Overrides:

[read](../../../java/io/FilterInputStream.html#read%28%29) in class [FilterInputStream](../../../java/io/FilterInputStream.html "class in java.io")

Returns:

the byte read, or -1 if end of compressed input is reached

Throws:

[IOException](../../../java/io/IOException.html "class in java.io") - if an I/O error has occurred

See Also:

FilterInputStream.in

read

public int read(byte[] b, int off, int len) throws IOException

Reads uncompressed data into an array of bytes. This method will block until some input can be decompressed.

Overrides:

[read](../../../java/io/FilterInputStream.html#read%28byte[], int, int%29) in class [FilterInputStream](../../../java/io/FilterInputStream.html "class in java.io")

Parameters:

b - the buffer into which the data is read

off - the start offset of the data

len - the maximum number of bytes read

Returns:

the actual number of bytes read, or -1 if the end of the compressed input is reached or a preset dictionary is needed

Throws:

[ZipException](../../../java/util/zip/ZipException.html "class in java.util.zip") - if a ZIP format error has occurred

[IOException](../../../java/io/IOException.html "class in java.io") - if an I/O error has occurred

See Also:

FilterInputStream.in

available

public int available() throws IOException

Returns 0 after EOF has been reached, otherwise always return 1.

Programs should not count on this method to return the actual number of bytes that could be read without blocking.

Overrides:

[available](../../../java/io/FilterInputStream.html#available%28%29) in class [FilterInputStream](../../../java/io/FilterInputStream.html "class in java.io")

Returns:

1 before EOF and 0 after EOF.

Throws:

[IOException](../../../java/io/IOException.html "class in java.io") - if an I/O error occurs.

See Also:

FilterInputStream.in

skip

public long skip(long n) throws IOException

Skips specified number of bytes of uncompressed data.

Overrides:

[skip](../../../java/io/FilterInputStream.html#skip%28long%29) in class [FilterInputStream](../../../java/io/FilterInputStream.html "class in java.io")

Parameters:

n - the number of bytes to skip

Returns:

the actual number of bytes skipped.

Throws:

[IOException](../../../java/io/IOException.html "class in java.io") - if an I/O error has occurred

[IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang") - if n < 0

close

public void close() throws IOException

Closes this input stream and releases any system resources associated with the stream.

Specified by:

[close](../../../java/io/Closeable.html#close%28%29) in interface [Closeable](../../../java/io/Closeable.html "interface in java.io")

Overrides:

[close](../../../java/io/FilterInputStream.html#close%28%29) in class [FilterInputStream](../../../java/io/FilterInputStream.html "class in java.io")

Throws:

[IOException](../../../java/io/IOException.html "class in java.io") - if an I/O error has occurred

See Also:

FilterInputStream.in

fill

protected void fill() throws IOException

Fills input buffer with more data to decompress.

Throws:

[IOException](../../../java/io/IOException.html "class in java.io") - if an I/O error has occurred

markSupported

public boolean markSupported()

Tests if this input stream supports the mark andreset methods. The markSupported method of InflaterInputStream returnsfalse.

Overrides:

[markSupported](../../../java/io/FilterInputStream.html#markSupported%28%29) in class [FilterInputStream](../../../java/io/FilterInputStream.html "class in java.io")

Returns:

a boolean indicating if this stream type supports the mark and reset methods.

mark

public void mark(int readlimit)

Marks the current position in this input stream.

The mark method of InflaterInputStream does nothing.

Overrides:

[mark](../../../java/io/FilterInputStream.html#mark%28int%29) in class [FilterInputStream](../../../java/io/FilterInputStream.html "class in java.io")

Parameters:

readlimit - the maximum limit of bytes that can be read before the mark position becomes invalid.

See Also:

InputStream.reset()

reset

public void reset() throws IOException

Repositions this stream to the position at the time themark method was last called on this input stream.

The method reset for classInflaterInputStream does nothing except throw anIOException.

Overrides:

[reset](../../../java/io/FilterInputStream.html#reset%28%29) in class [FilterInputStream](../../../java/io/FilterInputStream.html "class in java.io")

Throws:

[IOException](../../../java/io/IOException.html "class in java.io") - if this method is invoked.

See Also:

InputStream.mark(int), IOException

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.