Class LZ4FrameInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

net.jpountz.lz4.LZ4FrameInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class LZ4FrameInputStream
extends FilterInputStream

Implementation of the v1.5.1 LZ4 Frame format. This class is NOT thread safe. Once a read fails with an IOException, every later read or skip on this stream throws an IOException as well.

Not Supported:

• Dependent blocks
• Legacy streams

Originally based on kafka's KafkaLZ4BlockInputStream.

See Also:

• LZ4 Framing Format Spec 1.5.1

Field Summary

Fields inherited from class FilterInputStream

in

Constructor Summary

Constructors

Constructor	Description
LZ4FrameInputStream(InputStream in)	Creates a new InputStream that will decompress data using fastest instances of LZ4SafeDecompressor and XXHash32.
LZ4FrameInputStream(InputStream in, boolean readSingleFrame)	Creates a new InputStream that will decompress data using fastest instances of LZ4SafeDecompressor and XXHash32.
LZ4FrameInputStream(InputStream in, LZ4SafeDecompressor decompressor, XXHash32 checksum)	Creates a new InputStream that will decompress data using the LZ4 algorithm.
LZ4FrameInputStream(InputStream in, LZ4SafeDecompressor decompressor, XXHash32 checksum, boolean readSingleFrame)	Creates a new InputStream that will decompress data using the LZ4 algorithm.

Method Summary

Modifier and Type	Method	Description
int	available()
void	close()
long	getExpectedContentSize()	Returns the optional Content Size value set in Frame Descriptor.
boolean	isExpectedContentSizeDefined()	Checks if the optionnal Content Size is set (FLG.Bits.CONTENT_SIZE is enabled).
void	mark(int readlimit)
boolean	markSupported()
int	read()
int	read(byte[] b, int off, int len)
void	reset()
long	skip(long n)

Methods inherited from class FilterInputStream

read

Methods inherited from class InputStream

nullInputStream, readAllBytes, readNBytes, readNBytes, skipNBytes, transferTo

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

LZ4FrameInputStream

public LZ4FrameInputStream(InputStream in)
                    throws IOException

Creates a new InputStream that will decompress data using fastest instances of LZ4SafeDecompressor and XXHash32. This instance will decompress all concatenated frames in their sequential order.

Parameters:

in - the stream to decompress

Throws:

IOException - if an I/O error occurs

See Also:

• LZ4FrameInputStream(InputStream, LZ4SafeDecompressor, XXHash32)
• LZ4Factory.fastestInstance()
• XXHashFactory.fastestInstance()

LZ4FrameInputStream

public LZ4FrameInputStream(InputStream in,
 boolean readSingleFrame)
                    throws IOException

Creates a new InputStream that will decompress data using fastest instances of LZ4SafeDecompressor and XXHash32.

Parameters:

in - the stream to decompress

readSingleFrame - whether read is stopped after the first non-skippable frame

Throws:

IOException - if an I/O error occurs

See Also:

• LZ4FrameInputStream(InputStream, LZ4SafeDecompressor, XXHash32)
• LZ4Factory.fastestInstance()
• XXHashFactory.fastestInstance()

LZ4FrameInputStream

public LZ4FrameInputStream(InputStream in,
 LZ4SafeDecompressor decompressor,
 XXHash32 checksum)
                    throws IOException

Creates a new InputStream that will decompress data using the LZ4 algorithm. This instance will decompress all concatenated frames in their sequential order.

Parameters:

in - the stream to decompress

decompressor - the decompressor to use

checksum - the hash function to use

Throws:

IOException - if an I/O error occurs

See Also:

• LZ4FrameInputStream(InputStream, LZ4SafeDecompressor, XXHash32, boolean)

LZ4FrameInputStream

public LZ4FrameInputStream(InputStream in,
 LZ4SafeDecompressor decompressor,
 XXHash32 checksum,
 boolean readSingleFrame)
                    throws IOException

Creates a new InputStream that will decompress data using the LZ4 algorithm.

Parameters:

in - the stream to decompress

decompressor - the decompressor to use

checksum - the hash function to use

readSingleFrame - whether read is stopped after the first non-skippable frame

Throws:

IOException - if an I/O error occurs

Method Details

read

public int read()
         throws IOException

Overrides:

read in class FilterInputStream

Throws:

IOException

read

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

Overrides:

read in class FilterInputStream

Throws:

IOException

skip

public long skip(long n)
          throws IOException

Overrides:

skip in class FilterInputStream

Throws:

IOException

available

public int available()
              throws IOException

Overrides:

available in class FilterInputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class FilterInputStream

Throws:

IOException

mark

public void mark(int readlimit)

Overrides:

mark in class FilterInputStream

reset

public void reset()
           throws IOException

Overrides:

reset in class FilterInputStream

Throws:

IOException

markSupported

public boolean markSupported()

Overrides:

markSupported in class FilterInputStream

getExpectedContentSize

public long getExpectedContentSize()
                            throws IOException

Returns the optional Content Size value set in Frame Descriptor. If the Content Size is not set (FLG.Bits.CONTENT_SIZE not enabled) in compressed stream, -1L is returned. A call to this method is valid only when this instance is supposed to read only one frame (readSingleFrame == true).

Returns:

the expected content size, or -1L if no expected content size is set in the frame.

Throws:

IOException - On input stream read exception

See Also:

• LZ4FrameInputStream(InputStream, LZ4SafeDecompressor, XXHash32, boolean)

isExpectedContentSizeDefined

public boolean isExpectedContentSizeDefined()
                                     throws IOException

Checks if the optionnal Content Size is set (FLG.Bits.CONTENT_SIZE is enabled).

Returns:

true if this instance is supposed to read only one frame and if the optional content size is set in the frame.

Throws:

IOException - On input stream read exception