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

Modifier and Type	Field and 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

Access	Constructor and Description
public	FramedLZ4CompressorOutputStream(final OutputStream the OutputStream to which to write the compressed data out) Constructs a new output stream that compresses data using the LZ4 frame format using the default block size of 4MB.
public	FramedLZ4CompressorOutputStream(final OutputStream the OutputStream to which to write the compressed data out, final FramedLZ4CompressorOutputStream.Parameters the parameters to use 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 and Description
private void	appendToBlockDependencyBuffer(final byte[] b, final int off, int len)
public void	close() Overrides java.io.OutputStream.close. Implements java.io.Closeable.close. Closes this output stream and releases any system resources associated with this stream.
public void	finish() Compresses all blockDataRemaining data and writes it to the stream, doesn't close the underlying stream.
private void	flushBlock()
public void	write(final byte[] the data. data, int the start offset in the data. off, int the number of bytes to write. len) Overrides java.io.OutputStream.write. Writes `len` bytes from the specified byte array starting at offset `off` to this output stream.
public void	write(final int the `byte`. b) Implements abstract java.io.OutputStream.write. Writes the specified byte to this output stream.
private void	writeFrameDescriptor()
private void	writeTrailer()

blockData	back to summary
private final byte[] blockData

blockDependencyBuffer	back to summary
private final byte[] blockDependencyBuffer

blockHash	back to summary
private final XXHash32 blockHash

collectedBlockDependencyBytes	back to summary
private int collectedBlockDependencyBytes

contentHash	back to summary
private final XXHash32 contentHash

currentIndex	back to summary
private int currentIndex

END_MARK	back to summary
private static final byte[] END_MARK

finished	back to summary
private boolean finished

oneByte	back to summary
private final byte[] oneByte

out	back to summary
private final OutputStream out

params	back to summary
private final FramedLZ4CompressorOutputStream.Parameters params

Constructor Detail

FramedLZ4CompressorOutputStream	back to summary
public FramedLZ4CompressorOutputStream(final 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:OutputStream the OutputStream to which to write the compressed data Exceptions IOException: if writing the signature fails

FramedLZ4CompressorOutputStream

back to summary

public FramedLZ4CompressorOutputStream(final 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:OutputStream: the OutputStream to which to write the compressed data

Exceptions

IOException:: if writing the signature fails

FramedLZ4CompressorOutputStream	back to summary
public FramedLZ4CompressorOutputStream(final OutputStream out, final 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:OutputStream the OutputStream to which to write the compressed data params:FramedLZ4CompressorOutputStream.Parameters the parameters to use Exceptions IOException: if writing the signature fails

FramedLZ4CompressorOutputStream

back to summary

public FramedLZ4CompressorOutputStream(final OutputStream out, final 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:OutputStream: the OutputStream to which to write the compressed data
params:FramedLZ4CompressorOutputStream.Parameters: the parameters to use

Exceptions

IOException:: if writing the signature fails

Method Detail

appendToBlockDependencyBuffer	back to summary
private void appendToBlockDependencyBuffer(final byte[] b, final int off, int len)

close back to summary

close	back to summary
public void close() throws IOException Overrides java.io.OutputStream.close. Implements java.io.Closeable.close. Doc from java.io.OutputStream.close. Closes this output stream and releases any system resources associated with this stream. The general contract of `close` is that it closes the output stream. A closed stream cannot perform output operations and cannot be reopened. Annotations @Override Exceptions IOException: if an I/O error occurs.

public void close() throws IOException

Overrides java.io.OutputStream.close.

Implements java.io.Closeable.close.

Doc from java.io.OutputStream.close.

Closes this output stream and releases any system resources associated with this stream. The general contract of close is that it closes the output stream. A closed stream cannot perform output operations and cannot be reopened.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

finish	back to summary
public void finish() throws IOException Compresses all blockDataRemaining data and writes it to the stream, doesn't close the underlying stream. Exceptions IOException: if an error occurs

finish

back to summary

public void finish() throws IOException

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

Exceptions

IOException:: if an error occurs

flushBlock	back to summary
private void flushBlock() throws IOException

write back to summary

write	back to summary
public void write(final byte[] data, int off, int len) throws IOException Overrides java.io.OutputStream.write. Doc from java.io.OutputStream.write. Writes `len` bytes from the specified byte array starting at offset `off` to this output stream. The general contract for `write(b, off, len)` is that some of the bytes in the array `b` are written to the output stream in order; element `b[off]` is the first byte written and `b[off+len-1]` is the last byte written by this operation. If `b` is `null`, a `NullPointerException` is thrown. If `off` is negative, or `len` is negative, or `off+len` is greater than the length of the array `b`, then an `IndexOutOfBoundsException` is thrown. Parameters data:byte[] the data. off:int the start offset in the data. len:int the number of bytes to write. Annotations @Override Exceptions IOException: if an I/O error occurs. In particular, an `IOException` is thrown if the output stream is closed.

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

Overrides java.io.OutputStream.write.

Doc from java.io.OutputStream.write.

Writes len bytes from the specified byte array starting at offset off to this output stream. The general contract for write(b, off, len) is that some of the bytes in the array b are written to the output stream in order; element b[off] is the first byte written and b[off+len-1] is the last byte written by this operation.

If b is null, a NullPointerException is thrown.

If off is negative, or len is negative, or off+len is greater than the length of the array b, then an IndexOutOfBoundsException is thrown.

Parameters

data:byte[]: the data.
off:int: the start offset in the data.
len:int: the number of bytes to write.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs. In particular, an IOException is thrown if the output stream is closed.

write back to summary

write	back to summary
public void write(final int b) throws IOException Implements abstract java.io.OutputStream.write. Doc from java.io.OutputStream.write. Writes the specified byte to this output stream. The general contract for `write` is that one byte is written to the output stream. The byte to be written is the eight low-order bits of the argument `b`. The 24 high-order bits of `b` are ignored. Parameters b:int the `byte`. Annotations @Override Exceptions IOException: if an I/O error occurs. In particular, an `IOException` may be thrown if the output stream has been closed.

public void write(final int b) throws IOException

Implements abstract java.io.OutputStream.write.

Doc from java.io.OutputStream.write.

Writes the specified byte to this output stream. The general contract for write is that one byte is written to the output stream. The byte to be written is the eight low-order bits of the argument b. The 24 high-order bits of b are ignored.

Parameters

b:int: the byte.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed.

writeFrameDescriptor	back to summary
private void writeFrameDescriptor() throws IOException

writeTrailer	back to summary
private void writeTrailer() throws IOException

org.apache.commons.compress.compressors.lz4 back to summary

public final Enum FramedLZ4CompressorOutputStream.BlockSize

Class Inheritance

extends Enum<FramedLZ4CompressorOutputStream.BlockSize>

java.lang.Object
java.lang.Enum
org.apache.commons.compress.compressors.lz4.FramedLZ4CompressorOutputStream.BlockSize

The block sizes supported by the format.

Field Summary

Modifier and Type	Field and Description
private final int	index
public static final FramedLZ4CompressorOutputStream.BlockSize	K256 Block size of 256K
public static final FramedLZ4CompressorOutputStream.BlockSize	K64 Block size of 64K
public static final FramedLZ4CompressorOutputStream.BlockSize	M1 Block size of 1M
public static final FramedLZ4CompressorOutputStream.BlockSize	M4 Block size of 4M
private final int	size

Constructor Summary

Access	Constructor and Description
private	BlockSize(final int size, final int index)

Method Summary

Modifier and Type	Method and Description
pack-priv int	getIndex()
pack-priv int	getSize()
public static FramedLZ4CompressorOutputStream.BlockSize	valueOf(String name)
public static FramedLZ4CompressorOutputStream.BlockSize[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

index	back to summary
private final int index

K256	back to summary
public static final FramedLZ4CompressorOutputStream.BlockSize K256 Block size of 256K

K64	back to summary
public static final FramedLZ4CompressorOutputStream.BlockSize K64 Block size of 64K

M1	back to summary
public static final FramedLZ4CompressorOutputStream.BlockSize M1 Block size of 1M

M4	back to summary
public static final FramedLZ4CompressorOutputStream.BlockSize M4 Block size of 4M

size	back to summary
private final int size

Constructor Detail

BlockSize	back to summary
private BlockSize(final int size, final int index)

Method Detail

getIndex	back to summary
pack-priv int getIndex()

getSize	back to summary
pack-priv int getSize()

valueOf	back to summary
public static FramedLZ4CompressorOutputStream.BlockSize valueOf(String name)

values	back to summary
public static FramedLZ4CompressorOutputStream.BlockSize[] values()

org.apache.commons.compress.compressors.lz4 back to summary

public Class FramedLZ4CompressorOutputStream.Parameters

Class Inheritance

extends Object

java.lang.Object
org.apache.commons.compress.compressors.lz4.FramedLZ4CompressorOutputStream.Parameters

Parameters of the LZ4 frame format.

Field Summary

Modifier and Type	Field and Description
private final FramedLZ4CompressorOutputStream.BlockSize	blockSize
public static final FramedLZ4CompressorOutputStream.Parameters	DEFAULT The default parameters of 4M block size, enabled content checksum, disabled block checksums and independent blocks.
private final Parameters	lz77params
private final boolean	withBlockChecksum
private final boolean	withBlockDependency
private final boolean	withContentChecksum

Constructor Summary

Access	Constructor and Description
public	Parameters(final FramedLZ4CompressorOutputStream.BlockSize the size of a single block. blockSize) Sets up custom a custom block size for the LZ4 stream but otherwise uses the defaults of enabled content checksum, disabled block checksums and independent blocks.
public	Parameters(final FramedLZ4CompressorOutputStream.BlockSize the size of a single block. blockSize, final boolean whether to write a content checksum withContentChecksum, final boolean whether to write a block checksum. Note that block checksums are not supported by the lz4 command line utility withBlockChecksum, final boolean whether a block may depend on the content of a previous block. Enabling this may improve compression ratio but makes it impossible to decompress the output in parallel. withBlockDependency) Sets up custom parameters for the LZ4 stream.
public	Parameters(final FramedLZ4CompressorOutputStream.BlockSize the size of a single block. blockSize, final boolean whether to write a content checksum withContentChecksum, final boolean whether to write a block checksum. Note that block checksums are not supported by the lz4 command line utility withBlockChecksum, final boolean whether a block may depend on the content of a previous block. Enabling this may improve compression ratio but makes it impossible to decompress the output in parallel. withBlockDependency, final Parameters parameters used to fine-tune compression, in particular to balance compression ratio vs compression speed. lz77params) Sets up custom parameters for the LZ4 stream.
public	Parameters(final FramedLZ4CompressorOutputStream.BlockSize the size of a single block. blockSize, final Parameters parameters used to fine-tune compression, in particular to balance compression ratio vs compression speed. lz77params) Sets up custom a custom block size for the LZ4 stream but otherwise uses the defaults of enabled content checksum, disabled block checksums and independent blocks.

Method Summary

Modifier and Type	Method and Description
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

blockSize	back to summary
private final FramedLZ4CompressorOutputStream.BlockSize blockSize

DEFAULT	back to summary
public static final FramedLZ4CompressorOutputStream.Parameters DEFAULT The default parameters of 4M block size, enabled content checksum, disabled block checksums and independent blocks. This matches the defaults of the lz4 command line utility.

DEFAULT

back to summary

public static final FramedLZ4CompressorOutputStream.Parameters DEFAULT

The default parameters of 4M block size, enabled content checksum, disabled block checksums and independent blocks.

This matches the defaults of the lz4 command line utility.

lz77params	back to summary
private final Parameters lz77params

withBlockChecksum	back to summary
private final boolean withBlockChecksum

withBlockDependency	back to summary
private final boolean withBlockDependency

withContentChecksum	back to summary
private final boolean withContentChecksum

Constructor Detail

Parameters	back to summary
public Parameters(final FramedLZ4CompressorOutputStream.BlockSize blockSize) Sets up custom a custom block size for the LZ4 stream but otherwise uses the defaults of enabled content checksum, disabled block checksums and independent blocks. Parameters blockSize:FramedLZ4CompressorOutputStream.BlockSize the size of a single block.

Parameters

back to summary

public Parameters(final FramedLZ4CompressorOutputStream.BlockSize blockSize)

Sets up custom a custom block size for the LZ4 stream but otherwise uses the defaults of enabled content checksum, disabled block checksums and independent blocks.

Parameters

blockSize:FramedLZ4CompressorOutputStream.BlockSize: the size of a single block.

Parameters	back to summary
public Parameters(final FramedLZ4CompressorOutputStream.BlockSize blockSize, final boolean withContentChecksum, final boolean withBlockChecksum, final boolean withBlockDependency) Sets up custom parameters for the LZ4 stream. Parameters blockSize:FramedLZ4CompressorOutputStream.BlockSize the size of a single block. withContentChecksum:boolean whether to write a content checksum withBlockChecksum:boolean whether to write a block checksum. Note that block checksums are not supported by the lz4 command line utility withBlockDependency:boolean whether a block may depend on the content of a previous block. Enabling this may improve compression ratio but makes it impossible to decompress the output in parallel.

Parameters

back to summary

public Parameters(final FramedLZ4CompressorOutputStream.BlockSize blockSize, final boolean withContentChecksum, final boolean withBlockChecksum, final boolean withBlockDependency)

Sets up custom parameters for the LZ4 stream.

Parameters

blockSize:FramedLZ4CompressorOutputStream.BlockSize: the size of a single block.
withContentChecksum:boolean: whether to write a content checksum
withBlockChecksum:boolean: whether to write a block checksum. Note that block checksums are not supported by the lz4 command line utility
withBlockDependency:boolean: whether a block may depend on the content of a previous block. Enabling this may improve compression ratio but makes it impossible to decompress the output in parallel.

Parameters

back to summary

public Parameters(final FramedLZ4CompressorOutputStream.BlockSize blockSize, final boolean withContentChecksum, final boolean withBlockChecksum, final boolean withBlockDependency, final Parameters lz77params)

Sets up custom parameters for the LZ4 stream.

Parameters

blockSize:FramedLZ4CompressorOutputStream.BlockSize: the size of a single block.
withContentChecksum:boolean: whether to write a content checksum
withBlockChecksum:boolean: whether to write a block checksum. Note that block checksums are not supported by the lz4 command line utility
withBlockDependency:boolean: whether a block may depend on the content of a previous block. Enabling this may improve compression ratio but makes it impossible to decompress the output in parallel.
lz77params:Parameters: parameters used to fine-tune compression, in particular to balance compression ratio vs compression speed.

Parameters

back to summary

public Parameters(final FramedLZ4CompressorOutputStream.BlockSize blockSize, final Parameters lz77params)

Sets up custom a custom block size for the LZ4 stream but otherwise uses the defaults of enabled content checksum, disabled block checksums and independent blocks.

Parameters

blockSize:FramedLZ4CompressorOutputStream.BlockSize: the size of a single block.
lz77params:Parameters: parameters used to fine-tune compression, in particular to balance compression ratio vs compression speed.

Method Detail

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

public Class FramedLZ4CompressorOutputStream

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum FramedLZ4CompressorOutputStream.BlockSize

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class FramedLZ4CompressorOutputStream.Parameters

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail