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

Class FramedLZ4CompressorOutputStream

java.lang.Object

java.io.OutputStream

org.apache.commons.compress.compressors.CompressorOutputStream

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

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class FramedLZ4CompressorOutputStream
extends CompressorOutputStream

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

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

Modifier and Type	Field	Description
private final byte[]	blockData
private final byte[]	blockDependencyBuffer
private final XXHash32	blockHash
private int	collectedBlockDependencyBytes
private final XXHash32	contentHash
private int	currentIndex
private static final byte[]	END_MARK
private boolean	finished
private final byte[]	oneByte
private final OutputStream	out
private final FramedLZ4CompressorOutputStream.Parameters	params

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
private void	appendToBlockDependencyBuffer(byte[] b, int off, int len)
void	close()
void	finish()	Compresses all remaining data and writes it to the stream, doesn't close the underlying stream.
private void	flushBlock()
void	write(byte[] data, int off, int len)
void	write(int b)
private void	writeFrameDescriptor()
private void	writeTrailer()

Methods inherited from class java.io.OutputStream

flush, nullOutputStream, write

Methods inherited from class java.lang.Object

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

Field Details

END_MARK

private static final byte[] END_MARK

oneByte

private final byte[] oneByte

blockData

private final byte[] blockData

out

private final OutputStream out

params

private final FramedLZ4CompressorOutputStream.Parameters params

finished

private boolean finished

currentIndex

private int currentIndex

contentHash

private final XXHash32 contentHash

blockHash

private final XXHash32 blockHash

blockDependencyBuffer

private final byte[] blockDependencyBuffer

collectedBlockDependencyBytes

private int collectedBlockDependencyBytes

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

write

public void write(int b)
           throws IOException

Specified by:

write in class OutputStream

Throws:

IOException

write

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

Overrides:

write in class OutputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class OutputStream

Throws:

IOException

finish

public void finish()
            throws IOException

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

Throws:

IOException - if an error occurs

writeFrameDescriptor

private void writeFrameDescriptor()
                           throws IOException

Throws:

IOException

flushBlock

private void flushBlock()
                 throws IOException

Throws:

IOException

writeTrailer

private void writeTrailer()
                   throws IOException

Throws:

IOException

appendToBlockDependencyBuffer

private void appendToBlockDependencyBuffer(byte[] b,
 int off,
 int len)