Class LZMACompressorInputStream
- java.lang.Object
-
- java.io.InputStream
-
- org.apache.commons.compress.compressors.CompressorInputStream
-
- org.apache.commons.compress.compressors.lzma.LZMACompressorInputStream
-
- All Implemented Interfaces:
Closeable
,AutoCloseable
,InputStreamStatistics
public class LZMACompressorInputStream extends CompressorInputStream implements InputStreamStatistics
LZMA decompressor.- Since:
- 1.6
-
-
Constructor Summary
Constructors Constructor Description LZMACompressorInputStream(InputStream inputStream)
Creates a new input stream that decompresses LZMA-compressed data from the specified input stream.LZMACompressorInputStream(InputStream inputStream, int memoryLimitInKb)
Creates a new input stream that decompresses LZMA-compressed data from the specified input stream.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description int
available()
void
close()
long
getCompressedCount()
static boolean
matches(byte[] signature, int length)
Checks if the signature matches what is expected for an lzma file.int
read()
int
read(byte[] buf, int off, int len)
long
skip(long n)
-
Methods inherited from class org.apache.commons.compress.compressors.CompressorInputStream
getBytesRead, getCount, getUncompressedCount
-
Methods inherited from class java.io.InputStream
mark, markSupported, nullInputStream, read, readAllBytes, readNBytes, readNBytes, reset, 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 Detail
-
LZMACompressorInputStream
public LZMACompressorInputStream(InputStream inputStream) throws IOException
Creates a new input stream that decompresses LZMA-compressed data from the specified input stream.- Parameters:
inputStream
- where to read the compressed data- Throws:
IOException
- if the input is not in the .lzma format, the input is corrupt or truncated, the .lzma headers specify sizes that are not supported by this implementation, or the underlyinginputStream
throws an exception
-
LZMACompressorInputStream
public LZMACompressorInputStream(InputStream inputStream, int memoryLimitInKb) throws IOException
Creates a new input stream that decompresses LZMA-compressed data from the specified input stream.- Parameters:
inputStream
- where to read the compressed datamemoryLimitInKb
- calculated memory use threshold. Throws MemoryLimitException if calculate memory use is above this threshold- Throws:
IOException
- if the input is not in the .lzma format, the input is corrupt or truncated, the .lzma headers specify sizes that are not supported by this implementation, or the underlyinginputStream
throws an exception- Since:
- 1.14
-
-
Method Detail
-
read
public int read() throws IOException
- Specified by:
read
in classInputStream
- Throws:
IOException
-
read
public int read(byte[] buf, int off, int len) throws IOException
- Overrides:
read
in classInputStream
- Throws:
IOException
-
skip
public long skip(long n) throws IOException
- Overrides:
skip
in classInputStream
- Throws:
IOException
-
available
public int available() throws IOException
- Overrides:
available
in classInputStream
- Throws:
IOException
-
close
public void close() throws IOException
- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Overrides:
close
in classInputStream
- Throws:
IOException
-
getCompressedCount
public long getCompressedCount()
- Specified by:
getCompressedCount
in interfaceInputStreamStatistics
- 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 an lzma file.- Parameters:
signature
- the bytes to checklength
- the number of bytes to check- Returns:
- true, if this stream is an lzma compressed stream, false otherwise
- Since:
- 1.10
-
-