Package org.apache.commons.compress.compressors.z

Class ZCompressorInputStream

java.lang.Object

java.io.InputStream

org.apache.commons.compress.compressors.CompressorInputStream

org.apache.commons.compress.compressors.lzw.LZWInputStream

org.apache.commons.compress.compressors.z.ZCompressorInputStream

All Implemented Interfaces:

Closeable, AutoCloseable, InputStreamStatistics

public class ZCompressorInputStream
extends LZWInputStream

Input stream that decompresses .Z files.

Since:

1.7

Constructor Summary

Constructors

Constructor	Description
ZCompressorInputStream(InputStream inputStream)	Constructs a new instance.
ZCompressorInputStream(InputStream inputStream, int memoryLimitInKiB)	Constructs a new instance.

Method Summary

Modifier and Type	Method	Description
static boolean	matches(byte[] signature, int length)	Checks if the signature matches what is expected for a Unix compress file.

Methods inherited from class org.apache.commons.compress.compressors.lzw.LZWInputStream

close, getCompressedCount, read, read

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

getBytesRead, getCount, getUncompressedCount

Methods inherited from class java.io.InputStream

available, mark, markSupported, nullInputStream, read, readAllBytes, readNBytes, readNBytes, reset, skip, skipNBytes, transferTo

Methods inherited from class java.lang.Object

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

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

getUncompressedCount

Constructor Details

ZCompressorInputStream

public ZCompressorInputStream(InputStream inputStream)
                       throws IOException

Constructs a new instance.

Parameters:

inputStream - The underlying input stream.

Throws:

IOException - if an I/O error occurs.

ZCompressorInputStream

public ZCompressorInputStream(InputStream inputStream,
 int memoryLimitInKiB)
                       throws IOException

Constructs a new instance.

Parameters:

inputStream - The underlying input stream.

memoryLimitInKiB - maximum allowed estimated memory usage in kibibytes.

Throws:

IOException - if an I/O error occurs.

Method Details

matches

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

Checks if the signature matches what is expected for a Unix compress file.

Parameters:

signature - the bytes to check

length - the number of bytes to check

Returns:

true, if this stream is a Unix compress compressed stream, false otherwise

Since:

1.9