org.archive.util.zip

Class OpenJDK7InflaterInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

org.archive.util.zip.OpenJDK7InflaterInputStream

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

Direct Known Subclasses:

OpenJDK7GZIPInputStream

public class OpenJDK7InflaterInputStream
extends java.io.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.

Author:

David Connelly

See Also:

Inflater

Field Summary

Fields

Modifier and Type	Field and Description
protected byte[]	buf Input buffer for decompression.
protected java.util.zip.Inflater	inf Decompressor for this stream.
protected int	len Length of input buffer.
protected boolean	usesDefaultInflater

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

Constructors

Constructor and Description
OpenJDK7InflaterInputStream(java.io.InputStream in) Creates a new input stream with a default decompressor and buffer size.
OpenJDK7InflaterInputStream(java.io.InputStream in, java.util.zip.Inflater inf) Creates a new input stream with the specified decompressor and a default buffer size.
OpenJDK7InflaterInputStream(java.io.InputStream in, java.util.zip.Inflater inf, int size) Creates a new input stream with the specified decompressor and buffer size.

Method Summary

Modifier and Type	Method and Description
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 and reset methods.
int	read() Reads a byte of uncompressed data.
int	read(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 the mark 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

Field Detail

inf

protected java.util.zip.Inflater inf

Decompressor for this stream.

buf

protected byte[] buf

Input buffer for decompression.

len

protected int len

Length of input buffer.

usesDefaultInflater

protected boolean usesDefaultInflater

Constructor Detail

OpenJDK7InflaterInputStream

public OpenJDK7InflaterInputStream(java.io.InputStream in,
                                   java.util.zip.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:

java.lang.IllegalArgumentException - if size is <= 0

OpenJDK7InflaterInputStream

public OpenJDK7InflaterInputStream(java.io.InputStream in,
                                   java.util.zip.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")

OpenJDK7InflaterInputStream

public OpenJDK7InflaterInputStream(java.io.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 java.io.IOException

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

Overrides:

read in class java.io.FilterInputStream

Returns:

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

Throws:

java.io.IOException - if an I/O error has occurred

read

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

Reads uncompressed data into an array of bytes. If len is not zero, the method will block until some input can be decompressed; otherwise, no bytes are read and 0 is returned.

Overrides:

read in class java.io.FilterInputStream

Parameters:

b - the buffer into which the data is read

off - the start offset in the destination array b

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:

java.lang.NullPointerException - If b is null.

java.lang.IndexOutOfBoundsException - If off is negative, len is negative, or len is greater than b.length - off

java.util.zip.ZipException - if a ZIP format error has occurred

java.io.IOException - if an I/O error has occurred

available

public int available()
              throws java.io.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 in class java.io.FilterInputStream

Returns:

1 before EOF and 0 after EOF.

Throws:

java.io.IOException - if an I/O error occurs.

skip

public long skip(long n)
          throws java.io.IOException

Skips specified number of bytes of uncompressed data.

Overrides:

skip in class java.io.FilterInputStream

Parameters:

n - the number of bytes to skip

Returns:

the actual number of bytes skipped.

Throws:

java.io.IOException - if an I/O error has occurred

java.lang.IllegalArgumentException - if n < 0

close

public void close()
           throws java.io.IOException

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

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class java.io.FilterInputStream

Throws:

java.io.IOException - if an I/O error has occurred

fill

protected void fill()
             throws java.io.IOException

Fills input buffer with more data to decompress.

Throws:

java.io.IOException - if an I/O error has occurred

markSupported

public boolean markSupported()

Tests if this input stream supports the mark and reset methods. The markSupported method of InflaterInputStream returns false.

Overrides:

markSupported in class java.io.FilterInputStream

Returns:

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

See Also:

InputStream.mark(int), InputStream.reset()

mark

public void mark(int readlimit)

Marks the current position in this input stream.

The mark method of InflaterInputStream does nothing.

Overrides:

mark in class java.io.FilterInputStream

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 java.io.IOException

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

The method reset for class InflaterInputStream does nothing except throw an IOException.

Overrides:

reset in class java.io.FilterInputStream

Throws:

java.io.IOException - if this method is invoked.

See Also:

InputStream.mark(int), IOException