org.apache.commons.compress.compressors.deflate

Class DeflateCompressorInputStream

java.lang.Object

java.io.InputStream

org.apache.commons.compress.compressors.CompressorInputStream

org.apache.commons.compress.compressors.deflate.DeflateCompressorInputStream

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, InputStreamStatistics

public class DeflateCompressorInputStream
extends CompressorInputStream
implements InputStreamStatistics

Deflate decompressor.

Since:

1.9

Field Summary

Fields

Modifier and Type	Field and Description
private CountingInputStream	countingStream
private java.io.InputStream	in
private java.util.zip.Inflater	inflater
private static int	MAGIC_1
private static int	MAGIC_2a
private static int	MAGIC_2b
private static int	MAGIC_2c
private static int	MAGIC_2d

Constructor Summary

Constructors

Constructor and Description
DeflateCompressorInputStream(java.io.InputStream inputStream) Creates a new input stream that decompresses Deflate-compressed data from the specified input stream.
DeflateCompressorInputStream(java.io.InputStream inputStream, DeflateParameters parameters) Creates a new input stream that decompresses Deflate-compressed data from the specified input stream.

Method Summary

Modifier and Type	Method and Description
int	available()
void	close()
long	getCompressedCount()
static boolean	matches(byte[] signature, int length) Checks if the signature matches what is expected for a zlib / deflated file with the zlib header.
int	read()
int	read(byte[] buf, int off, int len)
long	skip(long n)

Methods inherited from class org.apache.commons.compress.compressors.CompressorInputStream

count, count, getBytesRead, getCount, getUncompressedCount, pushedBackBytes

Methods inherited from class java.io.InputStream

mark, markSupported, read, reset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.commons.compress.utils.InputStreamStatistics

getUncompressedCount

Field Detail

MAGIC_1

private static final int MAGIC_1

See Also:

Constant Field Values

MAGIC_2a

private static final int MAGIC_2a

See Also:

Constant Field Values

MAGIC_2b

private static final int MAGIC_2b

See Also:

Constant Field Values

MAGIC_2c

private static final int MAGIC_2c

See Also:

Constant Field Values

MAGIC_2d

private static final int MAGIC_2d

See Also:

Constant Field Values

countingStream

private final CountingInputStream countingStream

in

private final java.io.InputStream in

inflater

private final java.util.zip.Inflater inflater

Constructor Detail

DeflateCompressorInputStream

public DeflateCompressorInputStream(java.io.InputStream inputStream)

Creates a new input stream that decompresses Deflate-compressed data from the specified input stream.

Parameters:

inputStream - where to read the compressed data

DeflateCompressorInputStream

public DeflateCompressorInputStream(java.io.InputStream inputStream,
                                    DeflateParameters parameters)

Creates a new input stream that decompresses Deflate-compressed data from the specified input stream.

Parameters:

inputStream - where to read the compressed data

parameters - parameters

Method Detail

read

public int read()
         throws java.io.IOException

Specified by:

read in class java.io.InputStream

Throws:

java.io.IOException

read

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

Overrides:

read in class java.io.InputStream

Throws:

java.io.IOException

skip

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

Overrides:

skip in class java.io.InputStream

Throws:

java.io.IOException

available

public int available()
              throws java.io.IOException

Overrides:

available in class java.io.InputStream

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class java.io.InputStream

Throws:

java.io.IOException

getCompressedCount

public long getCompressedCount()

Specified by:

getCompressedCount in interface InputStreamStatistics

Returns:

the amount of raw or compressed bytes read by the stream

Since:

1.17

matches

public static boolean matches(byte[] signature,
                              int length)

Checks if the signature matches what is expected for a zlib / deflated file with the zlib header.

Parameters:

signature - the bytes to check

length - the number of bytes to check

Returns:

true, if this stream is zlib / deflate compressed with a header stream, false otherwise

Since:

1.10