org.apache.commons.compress.compressors.lz4

Class BlockLZ4CompressorOutputStream

java.lang.Object

java.io.OutputStream

org.apache.commons.compress.compressors.CompressorOutputStream

org.apache.commons.compress.compressors.lz4.BlockLZ4CompressorOutputStream

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable

public class BlockLZ4CompressorOutputStream
extends CompressorOutputStream

CompressorOutputStream for the LZ4 block format.

Since:

1.14

See Also:

LZ4 Block Format Description

Constructor Summary

Constructors

Constructor and Description
BlockLZ4CompressorOutputStream(java.io.OutputStream os) Creates a new LZ4 output stream.
BlockLZ4CompressorOutputStream(java.io.OutputStream os, Parameters params) Creates a new LZ4 output stream.

Method Summary

Modifier and Type	Method and Description
void	close()
static Parameters.Builder	createParameterBuilder() Returns a builder correctly configured for the LZ4 algorithm.
void	finish() Compresses all remaining data and writes it to the stream, doesn't close the underlying stream.
void	prefill(byte[] data, int off, int len) Adds some initial data to fill the window with.
void	write(byte[] data, int off, int len)
void	write(int b)

Methods inherited from class java.io.OutputStream

flush, write

Methods inherited from class java.lang.Object

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

Constructor Detail

BlockLZ4CompressorOutputStream

public BlockLZ4CompressorOutputStream(java.io.OutputStream os)
                               throws java.io.IOException

Creates a new LZ4 output stream.

Parameters:

os - An OutputStream to read compressed data from

Throws:

java.io.IOException - if reading fails

BlockLZ4CompressorOutputStream

public BlockLZ4CompressorOutputStream(java.io.OutputStream os,
                                      Parameters params)
                               throws java.io.IOException

Creates a new LZ4 output stream.

Parameters:

os - An OutputStream to read compressed data from

params - The parameters to use for LZ77 compression.

Throws:

java.io.IOException - if reading fails

Method Detail

write

public void write(int b)
           throws java.io.IOException

Specified by:

write in class java.io.OutputStream

Throws:

java.io.IOException

write

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

Overrides:

write in class java.io.OutputStream

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class java.io.OutputStream

Throws:

java.io.IOException

finish

public void finish()
            throws java.io.IOException

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

Throws:

java.io.IOException - if an error occurs

prefill

public void prefill(byte[] data,
                    int off,
                    int len)

Adds some initial data to fill the window with.

Parameters:

data - the data to fill the window with.

off - offset of real data into the array

len - amount of data

Throws:

java.lang.IllegalStateException - if the stream has already started to write data

See Also:

LZ77Compressor.prefill(byte[])

createParameterBuilder

public static Parameters.Builder createParameterBuilder()

Returns a builder correctly configured for the LZ4 algorithm.

Returns:

a builder correctly configured for the LZ4 algorithm