Class FramedLZ4CompressorInputStream
- java.lang.Object
-
- java.io.InputStream
-
- org.apache.commons.compress.compressors.CompressorInputStream
-
- org.apache.commons.compress.compressors.lz4.FramedLZ4CompressorInputStream
-
- All Implemented Interfaces:
java.io.Closeable
,java.lang.AutoCloseable
,InputStreamStatistics
public class FramedLZ4CompressorInputStream extends CompressorInputStream implements InputStreamStatistics
CompressorInputStream for the LZ4 frame format.Based on the "spec" in the version "1.5.1 (31/03/2015)"
- Since:
- 1.14
- See Also:
- LZ4 Frame Format Description
-
-
Constructor Summary
Constructors Constructor Description FramedLZ4CompressorInputStream(java.io.InputStream in)
Creates a new input stream that decompresses streams compressed using the LZ4 frame format and stops after decompressing the first frame.FramedLZ4CompressorInputStream(java.io.InputStream in, boolean decompressConcatenated)
Creates a new input stream that decompresses streams compressed using the LZ4 frame format.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description 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 a .lz4 file.int
read()
int
read(byte[] b, int off, int len)
-
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, 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
-
FramedLZ4CompressorInputStream
public FramedLZ4CompressorInputStream(java.io.InputStream in) throws java.io.IOException
Creates a new input stream that decompresses streams compressed using the LZ4 frame format and stops after decompressing the first frame.- Parameters:
in
- the InputStream from which to read the compressed data- Throws:
java.io.IOException
- if reading fails
-
FramedLZ4CompressorInputStream
public FramedLZ4CompressorInputStream(java.io.InputStream in, boolean decompressConcatenated) throws java.io.IOException
Creates a new input stream that decompresses streams compressed using the LZ4 frame format.- Parameters:
in
- the InputStream from which to read the compressed datadecompressConcatenated
- if true, decompress until the end of the input; if false, stop after the first LZ4 frame and leave the input position to point to the next byte after the frame stream- Throws:
java.io.IOException
- if reading fails
-
-
Method Detail
-
matches
public static boolean matches(byte[] signature, int length)
Checks if the signature matches what is expected for a .lz4 file..lz4 files start with a four byte signature.
- Parameters:
signature
- the bytes to checklength
- the number of bytes to check- Returns:
- true if this is a .sz stream, false otherwise
-
close
public void close() throws java.io.IOException
- Specified by:
close
in interfacejava.lang.AutoCloseable
- Specified by:
close
in interfacejava.io.Closeable
- Overrides:
close
in classjava.io.InputStream
- Throws:
java.io.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 interfaceInputStreamStatistics
- Returns:
- the amount of raw or compressed bytes read by the stream.
- Since:
- 1.17
-
read
public int read() throws java.io.IOException
- Specified by:
read
in classjava.io.InputStream
- Throws:
java.io.IOException
-
read
public int read(byte[] b, int off, int len) throws java.io.IOException
- Overrides:
read
in classjava.io.InputStream
- Throws:
java.io.IOException
-
-