public class SingleXZInputStream
extends java.io.InputStream
Unless you know what you are doing, don't use this class to decompress
standalone .xz files. For that purpose, use XZInputStream.
If you are decompressing complete XZ streams and your application knows
exactly how much uncompressed data there should be, it is good to try
reading one more byte by calling read() and checking
that it returns -1. This way the decompressor will parse the
file footers and verify the integrity checks, giving the caller more
confidence that the uncompressed data is valid.
XZInputStream| Constructor and Description |
|---|
SingleXZInputStream(java.io.InputStream in)
Creates a new XZ decompressor that decompresses exactly one
XZ Stream from
in without a memory usage limit. |
SingleXZInputStream(java.io.InputStream in,
int memoryLimit)
Creates a new XZ decompressor that decompresses exactly one
XZ Stream from
in with an optional memory usage limit. |
SingleXZInputStream(java.io.InputStream in,
int memoryLimit,
boolean verifyCheck)
Creates a new XZ decompressor that decompresses exactly one
XZ Stream from
in with an optional memory usage limit
and ability to disable verification of integrity checks. |
| Modifier and Type | Method and Description |
|---|---|
int |
available()
Returns the number of uncompressed bytes that can be read
without blocking.
|
void |
close()
Closes the stream and calls
in.close(). |
java.lang.String |
getCheckName()
Gets the name of the integrity check used in this XZ Stream.
|
int |
getCheckType()
Gets the ID of the integrity check used in this XZ Stream.
|
int |
read()
Decompresses the next byte from this input stream.
|
int |
read(byte[] buf,
int off,
int len)
Decompresses into an array of bytes.
|
public SingleXZInputStream(java.io.InputStream in)
throws java.io.IOException
in without a memory usage limit.
This constructor reads and parses the XZ Stream Header (12 bytes)
from in. The header of the first Block is not read
until read is called.
in - input stream from which XZ-compressed
data is readXZFormatException - input is not in the XZ formatCorruptedInputException - XZ header CRC32 doesn't matchUnsupportedOptionsException - XZ header is valid but specifies options
not supported by this implementationjava.io.EOFException - less than 12 bytes of input was available
from injava.io.IOException - may be thrown by inpublic SingleXZInputStream(java.io.InputStream in,
int memoryLimit)
throws java.io.IOException
in with an optional memory usage limit.
This is identical to SingleXZInputStream(InputStream)
except that this takes also the memoryLimit argument.
in - input stream from which XZ-compressed
data is readmemoryLimit - memory usage limit in kibibytes (KiB)
or -1 to impose no
memory usage limitXZFormatException - input is not in the XZ formatCorruptedInputException - XZ header CRC32 doesn't matchUnsupportedOptionsException - XZ header is valid but specifies options
not supported by this implementationjava.io.EOFException - less than 12 bytes of input was available
from injava.io.IOException - may be thrown by inpublic SingleXZInputStream(java.io.InputStream in,
int memoryLimit,
boolean verifyCheck)
throws java.io.IOException
in with an optional memory usage limit
and ability to disable verification of integrity checks.
This is identical to SingleXZInputStream(InputStream,int)
except that this takes also the verifyCheck argument.
Note that integrity check verification should almost never be disabled. Possible reasons to disable integrity check verification:
verifyCheck only affects the integrity check of
the actual compressed data. The CRC32 fields in the headers
are always verified.
in - input stream from which XZ-compressed
data is readmemoryLimit - memory usage limit in kibibytes (KiB)
or -1 to impose no
memory usage limitverifyCheck - if true, the integrity checks
will be verified; this should almost never
be set to falseXZFormatException - input is not in the XZ formatCorruptedInputException - XZ header CRC32 doesn't matchUnsupportedOptionsException - XZ header is valid but specifies options
not supported by this implementationjava.io.EOFException - less than 12 bytes of input was available
from injava.io.IOException - may be thrown by inpublic int getCheckType()
public java.lang.String getCheckName()
public int read()
throws java.io.IOException
Reading lots of data with read() from this input stream
may be inefficient. Wrap it in BufferedInputStream
if you need to read lots of data one byte at a time.
read in class java.io.InputStream-1
to indicate the end of the compressed streamCorruptedInputExceptionUnsupportedOptionsExceptionMemoryLimitExceptionXZIOException - if the stream has been closedjava.io.EOFException - compressed input is truncated or corruptjava.io.IOException - may be thrown by inpublic int read(byte[] buf,
int off,
int len)
throws java.io.IOException
If len is zero, no bytes are read and 0
is returned. Otherwise this will try to decompress len
bytes of uncompressed data. Less than len bytes may
be read only in the following situations:
len
bytes have already been successfully decompressed.
The next call with non-zero len will immediately
throw the pending exception.read in class java.io.InputStreambuf - target buffer for uncompressed dataoff - start offset in buflen - maximum number of uncompressed bytes to read-1 to indicate
the end of the compressed streamCorruptedInputExceptionUnsupportedOptionsExceptionMemoryLimitExceptionXZIOException - if the stream has been closedjava.io.EOFException - compressed input is truncated or corruptjava.io.IOException - may be thrown by inpublic int available()
throws java.io.IOException
CorruptedInputException may get
thrown before the number of bytes claimed to be available have
been read from this input stream.available in class java.io.InputStreamjava.io.IOExceptionpublic void close()
throws java.io.IOException
in.close().
If the stream was already closed, this does nothing.close in interface java.io.Closeableclose in interface java.lang.AutoCloseableclose in class java.io.InputStreamjava.io.IOException - if thrown by in.close()