Class XZCompressorInputStream
java.lang.Object
java.io.InputStream
org.apache.commons.compress.compressors.CompressorInputStream
org.apache.commons.compress.compressors.xz.XZCompressorInputStream
- All Implemented Interfaces:
Closeable,AutoCloseable,InputStreamStatistics
XZ decompressor.
For example:
XZCompressorInputStream s = XZCompressorInputStream.builder()
.setPath(path)
.setDecompressConcatenated(false)
.setMemoryLimitKiB(-1)
.get();
- Since:
- 1.4
-
Nested Class Summary
Nested Classes -
Constructor Summary
ConstructorsConstructorDescriptionXZCompressorInputStream(InputStream inputStream) Creates a new input stream that decompresses XZ-compressed data from the specified input stream.XZCompressorInputStream(InputStream inputStream, boolean decompressConcatenated) Deprecated.XZCompressorInputStream(InputStream inputStream, boolean decompressConcatenated, int memoryLimitKiB) Deprecated.Usebuilder(). -
Method Summary
Modifier and TypeMethodDescriptionintbuilder()Constructs a new builder ofLZMACompressorOutputStream.voidclose()longGets the amount of raw or compressed bytes read by the stream.static booleanmatches(byte[] signature, int length) Checks if the signature matches what is expected for a .xz file.intread()intread(byte[] buf, int off, int len) longskip(long n) Methods inherited from class org.apache.commons.compress.compressors.CompressorInputStream
count, count, getBytesRead, getCount, getUncompressedCount, pushedBackBytesMethods inherited from class java.io.InputStream
mark, markSupported, read, resetMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.apache.commons.compress.utils.InputStreamStatistics
getUncompressedCount
-
Constructor Details
-
XZCompressorInputStream
Creates a new input stream that decompresses XZ-compressed data from the specified input stream. This doesn't support concatenated .xz files.- Parameters:
inputStream- where to read the compressed data- Throws:
IOException- if the input is not in the .xz format, the input is corrupt or truncated, the .xz headers specify options that are not supported by this implementation, or the underlyinginputStreamthrows an exception
-
XZCompressorInputStream
@Deprecated public XZCompressorInputStream(InputStream inputStream, boolean decompressConcatenated) throws IOException Deprecated.Usebuilder().Creates a new input stream that decompresses XZ-compressed data from the specified input stream.- Parameters:
inputStream- where to read the compressed datadecompressConcatenated- if true, decompress until the end of the input; if false, stop after the first .xz stream and leave the input position to point to the next byte after the .xz stream- Throws:
IOException- if the input is not in the .xz format, the input is corrupt or truncated, the .xz headers specify options that are not supported by this implementation, or the underlyinginputStreamthrows an exception
-
XZCompressorInputStream
@Deprecated public XZCompressorInputStream(InputStream inputStream, boolean decompressConcatenated, int memoryLimitKiB) throws IOException Deprecated.Usebuilder().Creates a new input stream that decompresses XZ-compressed data from the specified input stream.- Parameters:
inputStream- where to read the compressed datadecompressConcatenated- if true, decompress until the end of the input; if false, stop after the first .xz stream and leave the input position to point to the next byte after the .xz streammemoryLimitKiB- The memory limit used when reading blocks. The memory usage limit is expressed in kibibytes (KiB) or-1to impose no memory usage limit. If the estimated memory limit is exceeded onread(), aMemoryLimitExceptionis thrown.- Throws:
IOException- if the input is not in the .xz format, the input is corrupt or truncated, the .xz headers specify options that are not supported by this implementation, or the underlyinginputStreamthrows an exception- Since:
- 1.14
-
-
Method Details
-
builder
Constructs a new builder ofLZMACompressorOutputStream.- Returns:
- a new builder of
LZMACompressorOutputStream. - Since:
- 1.28.0
-
matches
Checks if the signature matches what is expected for a .xz file.- Parameters:
signature- the bytes to checklength- the number of bytes to check- Returns:
- true if signature matches the .xz magic bytes, false otherwise
-
available
- Overrides:
availablein classInputStream- Throws:
IOException
-
close
- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceCloseable- Overrides:
closein classInputStream- Throws:
IOException
-
getCompressedCount
Description copied from interface:InputStreamStatisticsGets the amount of raw or compressed bytes read by the stream.- Specified by:
getCompressedCountin interfaceInputStreamStatistics- Returns:
- the amount of raw or compressed bytes read by the stream.
- Since:
- 1.17
-
read
- Specified by:
readin classInputStream- Throws:
IOException
-
read
- Overrides:
readin classInputStream- Throws:
IOException
-
skip
- Overrides:
skipin classInputStream- Throws:
IOException
-
builder().