Package org.apache.commons.compress.compressors.lzma

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LZMACompressorInputStream.Builder	Builds a new LZMACompressorInputStream.

Field Summary

Fields

Modifier and Type	Field	Description
private final org.apache.commons.io.input.BoundedInputStream	countingStream
private final InputStream	in

Constructor Summary

Constructors

Modifier	Constructor	Description
	LZMACompressorInputStream(InputStream inputStream)	Creates a new input stream that decompresses LZMA-compressed data from the specified input stream.
	LZMACompressorInputStream(InputStream inputStream, int memoryLimitKiB)	Deprecated. Use builder().
private	LZMACompressorInputStream(LZMACompressorInputStream.Builder builder)

Method Summary

Modifier and Type	Method	Description
int	available()
static LZMACompressorInputStream.Builder	builder()	Constructs a new builder of LZMACompressorOutputStream.
void	close()
long	getCompressedCount()	Gets the amount of raw or compressed bytes read by the stream.
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

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 Details

countingStream

private final org.apache.commons.io.input.BoundedInputStream countingStream

in

private final InputStream in

Constructor Details

LZMACompressorInputStream

private LZMACompressorInputStream(LZMACompressorInputStream.Builder builder)
                           throws IOException

Throws:

IOException

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 underlying inputStream throws an exception

LZMACompressorInputStream

@Deprecated
public LZMACompressorInputStream(InputStream inputStream,
 int memoryLimitKiB)
                          throws IOException

Deprecated.

Use builder().

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

Parameters:

inputStream - where to read the compressed data

memoryLimitKiB - Sets a working memory threshold in kibibytes (KiB). Processing throws MemoryLimitException if 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 underlying inputStream throws an exception

Since:

1.14

Method Details

builder

public static LZMACompressorInputStream.Builder builder()

Constructs a new builder of LZMACompressorOutputStream.

Returns:

a new builder of LZMACompressorOutputStream.

Since:

1.28.0

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 check

length - the number of bytes to check

Returns:

true, if this stream is an LZMA compressed stream, false otherwise

Since:

1.10

available

public int available()
              throws IOException

Overrides:

available in class InputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class InputStream

Throws:

IOException

getCompressedCount

public long getCompressedCount()

Description copied from interface: InputStreamStatistics

Gets the amount of raw or compressed bytes read by the stream.

Specified by:

getCompressedCount in interface InputStreamStatistics

Returns:

the amount of raw or compressed bytes read by the stream.

Since:

1.17

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

read

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

Overrides:

read in class InputStream

Throws:

IOException

skip

public long skip(long n)
          throws IOException

Overrides:

skip in class InputStream

Throws:

IOException