Package org.apache.commons.compress.compressors.lz4

Class FramedLZ4CompressorOutputStream

java.lang.Object

java.io.OutputStream

java.io.FilterOutputStream

org.apache.commons.compress.compressors.CompressorOutputStream<OutputStream>

org.apache.commons.compress.compressors.lz4.FramedLZ4CompressorOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class FramedLZ4CompressorOutputStream
extends CompressorOutputStream<OutputStream>

CompressorOutputStream 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

This class is not thread-safe

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	FramedLZ4CompressorOutputStream.BlockSize	The block sizes supported by the format.
static class	FramedLZ4CompressorOutputStream.Parameters	Parameters of the LZ4 frame format.

Field Summary

Fields inherited from class java.io.FilterOutputStream

out

Constructor Summary

Constructors

Constructor	Description
FramedLZ4CompressorOutputStream(OutputStream out)	Constructs a new output stream that compresses data using the LZ4 frame format using the default block size of 4MB.
FramedLZ4CompressorOutputStream(OutputStream out, FramedLZ4CompressorOutputStream.Parameters params)	Constructs a new output stream that compresses data using the LZ4 frame format using the given block size.

Method Summary

Modifier and Type	Method	Description
void	close()
void	finish()	Compresses all blockDataRemaining data and writes it to the stream, doesn't close the underlying stream.
void	write(byte[] data, int off, int len)
void	write(int b)

Methods inherited from class org.apache.commons.compress.compressors.CompressorOutputStream

out

Methods inherited from class java.io.FilterOutputStream

flush, write

Methods inherited from class java.lang.Object

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

Constructor Details

FramedLZ4CompressorOutputStream

public FramedLZ4CompressorOutputStream(OutputStream out)
                                throws IOException

Constructs a new output stream that compresses data using the LZ4 frame format using the default block size of 4MB.

Parameters:

out - the OutputStream to which to write the compressed data

Throws:

IOException - if writing the signature fails

FramedLZ4CompressorOutputStream

public FramedLZ4CompressorOutputStream(OutputStream out,
 FramedLZ4CompressorOutputStream.Parameters params)
                                throws IOException

Constructs a new output stream that compresses data using the LZ4 frame format using the given block size.

Parameters:

out - the OutputStream to which to write the compressed data

params - the parameters to use

Throws:

IOException - if writing the signature fails

Method Details

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

finish

public void finish()
            throws IOException

Compresses all blockDataRemaining data and writes it to the stream, doesn't close the underlying stream.

Throws:

IOException - if an error occurs

write

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

Overrides:

write in class FilterOutputStream

Throws:

IOException

write

public void write(int b)
           throws IOException

Overrides:

write in class FilterOutputStream

Throws:

IOException