Package net.jpountz.lz4

Class LZ4FrameOutputStream

java.lang.Object

java.io.OutputStream

java.io.FilterOutputStream

net.jpountz.lz4.LZ4FrameOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class LZ4FrameOutputStream
extends FilterOutputStream

Implementation of the v1.5.1 LZ4 Frame format. This class is NOT thread safe.

Not Supported:

• Dependent blocks
• Legacy streams
• Multiple frames (one LZ4FrameOutputStream is one frame)

Originally based on kafka's KafkaLZ4BlockOutputStream.

See Also:

• LZ4 Framing Format Spec 1.5.1

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LZ4FrameOutputStream.BD
static enum	LZ4FrameOutputStream.BLOCKSIZE
static class	LZ4FrameOutputStream.FLG

Field Summary

Fields inherited from class java.io.FilterOutputStream

out

Constructor Summary

Constructors

Constructor	Description
LZ4FrameOutputStream(OutputStream out)	Creates a new OutputStream that will compress data using the LZ4 algorithm with 4-MB blocks.
LZ4FrameOutputStream(OutputStream out, LZ4FrameOutputStream.BLOCKSIZE blockSize)	Creates a new OutputStream that will compress data using the LZ4 algorithm.
LZ4FrameOutputStream(OutputStream out, LZ4FrameOutputStream.BLOCKSIZE blockSize, long knownSize, LZ4Compressor compressor, XXHash32 checksum, LZ4FrameOutputStream.FLG.Bits... bits)	Creates a new OutputStream that will compress data using the specified instances of LZ4Compressor and XXHash32.
LZ4FrameOutputStream(OutputStream out, LZ4FrameOutputStream.BLOCKSIZE blockSize, long knownSize, LZ4FrameOutputStream.FLG.Bits... bits)	Creates a new OutputStream that will compress data using using fastest instances of LZ4Compressor and XXHash32.
LZ4FrameOutputStream(OutputStream out, LZ4FrameOutputStream.BLOCKSIZE blockSize, LZ4FrameOutputStream.FLG.Bits... bits)	Creates a new OutputStream that will compress data of unknown size using the LZ4 algorithm.

Method Summary

Modifier and Type	Method	Description
void	close()
void	flush()
void	write(byte[] b, int off, int len)
void	write(int b)

Methods inherited from class java.io.FilterOutputStream

write

Methods inherited from class java.io.OutputStream

nullOutputStream

Methods inherited from class java.lang.Object

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

Constructor Details

LZ4FrameOutputStream

public LZ4FrameOutputStream(OutputStream out,
 LZ4FrameOutputStream.BLOCKSIZE blockSize,
 LZ4FrameOutputStream.FLG.Bits... bits)
                     throws IOException

Creates a new OutputStream that will compress data of unknown size using the LZ4 algorithm.

Parameters:

out - the output stream to compress

blockSize - the BLOCKSIZE to use

bits - a set of features to use

Throws:

IOException - if an I/O error occurs

See Also:

• LZ4FrameOutputStream(OutputStream, BLOCKSIZE, long, FLG.Bits...)

LZ4FrameOutputStream

public LZ4FrameOutputStream(OutputStream out,
 LZ4FrameOutputStream.BLOCKSIZE blockSize,
 long knownSize,
 LZ4FrameOutputStream.FLG.Bits... bits)
                     throws IOException

Creates a new OutputStream that will compress data using using fastest instances of LZ4Compressor and XXHash32.

Parameters:

out - the output stream to compress

blockSize - the BLOCKSIZE to use

knownSize - the size of the uncompressed data. A value less than zero means unknown.

bits - a set of features to use

Throws:

IOException - if an I/O error occurs

LZ4FrameOutputStream

public LZ4FrameOutputStream(OutputStream out,
 LZ4FrameOutputStream.BLOCKSIZE blockSize,
 long knownSize,
 LZ4Compressor compressor,
 XXHash32 checksum,
 LZ4FrameOutputStream.FLG.Bits... bits)
                     throws IOException

Creates a new OutputStream that will compress data using the specified instances of LZ4Compressor and XXHash32.

Parameters:

out - the output stream to compress

blockSize - the BLOCKSIZE to use

knownSize - the size of the uncompressed data. A value less than zero means unknown.

compressor - the LZ4Compressor instance to use to compress data

checksum - the XXHash32 instance to use to check data for integrity

bits - a set of features to use

Throws:

IOException - if an I/O error occurs

LZ4FrameOutputStream

public LZ4FrameOutputStream(OutputStream out,
 LZ4FrameOutputStream.BLOCKSIZE blockSize)
                     throws IOException

Creates a new OutputStream that will compress data using the LZ4 algorithm. The block independence flag is set, and none of the other flags are set.

Parameters:

out - The stream to compress

blockSize - the BLOCKSIZE to use

Throws:

IOException - if an I/O error occurs

See Also:

• LZ4FrameOutputStream(OutputStream, BLOCKSIZE, FLG.Bits...)

LZ4FrameOutputStream

public LZ4FrameOutputStream(OutputStream out)
                     throws IOException

Creates a new OutputStream that will compress data using the LZ4 algorithm with 4-MB blocks.

Parameters:

out - the output stream to compress

Throws:

IOException - if an I/O error occurs

See Also:

• LZ4FrameOutputStream(OutputStream, BLOCKSIZE)

Method Details

write

public void write(int b)
           throws IOException

Overrides:

write in class FilterOutputStream

Throws:

IOException

write

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

Overrides:

write in class FilterOutputStream

Throws:

IOException

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Overrides:

flush in class FilterOutputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class FilterOutputStream

Throws:

IOException