Modifier and Type	Class and Description
pack-priv static class	BlockLZ4CompressorOutputStream.Pair

Modifier and Type	Field and Description
private final LZ77Compressor	compressor
private final Deque<byte[]>	expandedBlocks
private boolean	finished
private static final int	MIN_BACK_REFERENCE_LENGTH
private static final int	MIN_OFFSET_OF_LAST_BACK_REFERENCE
private final byte[]	oneByte
private final OutputStream	os
private final Deque<BlockLZ4CompressorOutputStream.Pair>	pairs

Access	Constructor and Description
public	BlockLZ4CompressorOutputStream(final OutputStream An OutputStream to read compressed data from os) Creates a new LZ4 output stream.
public	BlockLZ4CompressorOutputStream(final OutputStream An OutputStream to read compressed data from os, final Parameters The parameters to use for LZ77 compression. params) Creates a new LZ4 output stream.

Method Summary

Modifier and Type	Method and Description
private void	addBackReference(final LZ77Compressor.BackReference block)
private void	addLiteralBlock(final LZ77Compressor.LiteralBlock block)
private void	clearUnusedBlocks()
private void	clearUnusedBlocksAndPairs()
private void	clearUnusedPairs()
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 static Parameters.Builder	Returns: a builder correctly configured for the LZ4 algorithm createParameterBuilder() Returns a builder correctly configured for the LZ4 algorithm.
private byte[]	expand(final int offset, final int length)
private void	expandFromList(final byte[] expanded, final int offset, final int length)
public void	finish() Compresses all remaining data and writes it to the stream, doesn't close the underlying stream.
public void	prefill(final byte[] the data to fill the window with. data, final int offset of real data into the array off, final int amount of data len) Adds some initial data to fill the window with.
private void	recordBackReference(final LZ77Compressor.BackReference block)
private void	recordLiteral(final byte[] b)
private void	rewriteLastPairs()
public void	write(final byte[] the data. data, final int the start offset in the data. off, final 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 BlockLZ4CompressorOutputStream.Pair	writeBlocksAndReturnUnfinishedPair(final int length)
private void	writeFinalLiteralBlock()
private void	writeWritablePairs(final int lengthOfBlocksAfterLastPair)

Field Detail

compressor	back to summary
private final LZ77Compressor compressor

expandedBlocks	back to summary
private final Deque<byte[]> expandedBlocks

finished	back to summary
private boolean finished

MIN_BACK_REFERENCE_LENGTH	back to summary
private static final int MIN_BACK_REFERENCE_LENGTH

MIN_OFFSET_OF_LAST_BACK_REFERENCE	back to summary
private static final int MIN_OFFSET_OF_LAST_BACK_REFERENCE

oneByte	back to summary
private final byte[] oneByte

os	back to summary
private final OutputStream os

pairs	back to summary
private final Deque<BlockLZ4CompressorOutputStream.Pair> pairs

Constructor Detail

BlockLZ4CompressorOutputStream	back to summary
public BlockLZ4CompressorOutputStream(final OutputStream os) Creates a new LZ4 output stream. Parameters os:OutputStream An OutputStream to read compressed data from

BlockLZ4CompressorOutputStream

back to summary

public BlockLZ4CompressorOutputStream(final OutputStream os)

Creates a new LZ4 output stream.

Parameters

os:OutputStream: An OutputStream to read compressed data from

BlockLZ4CompressorOutputStream	back to summary
public BlockLZ4CompressorOutputStream(final OutputStream os, final Parameters params) Creates a new LZ4 output stream. Parameters os:OutputStream An OutputStream to read compressed data from params:Parameters The parameters to use for LZ77 compression.

BlockLZ4CompressorOutputStream

back to summary

public BlockLZ4CompressorOutputStream(final OutputStream os, final Parameters params)

Creates a new LZ4 output stream.

Parameters

os:OutputStream: An OutputStream to read compressed data from
params:Parameters: The parameters to use for LZ77 compression.

Method Detail

addBackReference	back to summary
private void addBackReference(final LZ77Compressor.BackReference block) throws IOException

addLiteralBlock	back to summary
private void addLiteralBlock(final LZ77Compressor.LiteralBlock block) throws IOException

clearUnusedBlocks	back to summary
private void clearUnusedBlocks()

clearUnusedBlocksAndPairs	back to summary
private void clearUnusedBlocksAndPairs()

clearUnusedPairs	back to summary
private void clearUnusedPairs()

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.

createParameterBuilder	back to summary
public static Parameters.Builder createParameterBuilder() Returns a builder correctly configured for the LZ4 algorithm. Returns:Parameters.Builder a builder correctly configured for the LZ4 algorithm

createParameterBuilder

back to summary

public static Parameters.Builder createParameterBuilder()

Returns a builder correctly configured for the LZ4 algorithm.

Returns:Parameters.Builder: a builder correctly configured for the LZ4 algorithm

expand	back to summary
private byte[] expand(final int offset, final int length)

expandFromList	back to summary
private void expandFromList(final byte[] expanded, final int offset, final int length)

finish	back to summary
public void finish() throws IOException Compresses all remaining 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 remaining data and writes it to the stream, doesn't close the underlying stream.

Exceptions

IOException:: if an error occurs

prefill back to summary

prefill	back to summary
public void prefill(final byte[] data, final int off, final int len) Adds some initial data to fill the window with. Parameters data:byte[] the data to fill the window with. off:int offset of real data into the array len:int amount of data Exceptions IllegalStateException: if the stream has already started to write data See Also `LZ77Compressor#prefill`

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

Adds some initial data to fill the window with.

Parameters

data:byte[]: the data to fill the window with.
off:int: offset of real data into the array
len:int: amount of data

Exceptions

IllegalStateException:: if the stream has already started to write data

See Also

LZ77Compressor#prefill

recordBackReference	back to summary
private void recordBackReference(final LZ77Compressor.BackReference block)

recordLiteral	back to summary
private void recordLiteral(final byte[] b)

rewriteLastPairs	back to summary
private void rewriteLastPairs()

write back to summary

write	back to summary
public void write(final byte[] data, final int off, final 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, final int off, final 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.

writeBlocksAndReturnUnfinishedPair	back to summary
private BlockLZ4CompressorOutputStream.Pair writeBlocksAndReturnUnfinishedPair(final int length) throws IOException

writeFinalLiteralBlock	back to summary
private void writeFinalLiteralBlock() throws IOException

writeWritablePairs	back to summary
private void writeWritablePairs(final int lengthOfBlocksAfterLastPair) throws IOException

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

pack-priv final Class BlockLZ4CompressorOutputStream.Pair

Class Inheritance

extends Object

java.lang.Object
org.apache.commons.compress.compressors.lz4.BlockLZ4CompressorOutputStream.Pair

Field Summary

Modifier and Type	Field and Description
private int	brLength
private int	brOffset
private int	literalLength
private final Deque<byte[]>	literals
private boolean	written

Constructor Summary

Access	Constructor and Description
pack-priv	Pair()

Method Summary

Modifier and Type	Method and Description
pack-priv byte[]	addLiteral(final LZ77Compressor.LiteralBlock block)
private int	backReferenceLength()
pack-priv boolean	canBeWritten(final int lengthOfBlocksAfterThisPair)
pack-priv boolean	hasBackReference()
private boolean	hasBeenWritten()
pack-priv int	length()
private static int	lengths(final int litLength, final int brLength)
private int	literalLength()
private void	prependLiteral(final byte[] data)
private void	prependTo(final BlockLZ4CompressorOutputStream.Pair other)
pack-priv void	setBackReference(final LZ77Compressor.BackReference block)
private BlockLZ4CompressorOutputStream.Pair	splitWithNewBackReferenceLengthOf(final int newBackReferenceLength)
private static void	writeLength(int length, final OutputStream out)
pack-priv void	writeTo(final OutputStream out)

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

Field Detail

brLength	back to summary
private int brLength

brOffset	back to summary
private int brOffset

literalLength	back to summary
private int literalLength

literals	back to summary
private final Deque<byte[]> literals

written	back to summary
private boolean written

Constructor Detail

Pair	back to summary
pack-priv Pair()

Method Detail

addLiteral	back to summary
pack-priv byte[] addLiteral(final LZ77Compressor.LiteralBlock block)

backReferenceLength	back to summary
private int backReferenceLength()

canBeWritten	back to summary
pack-priv boolean canBeWritten(final int lengthOfBlocksAfterThisPair)

hasBackReference	back to summary
pack-priv boolean hasBackReference()

hasBeenWritten	back to summary
private boolean hasBeenWritten()

length	back to summary
pack-priv int length()

lengths	back to summary
private static int lengths(final int litLength, final int brLength)

literalLength	back to summary
private int literalLength()

prependLiteral	back to summary
private void prependLiteral(final byte[] data)

prependTo	back to summary
private void prependTo(final BlockLZ4CompressorOutputStream.Pair other)

setBackReference	back to summary
pack-priv void setBackReference(final LZ77Compressor.BackReference block)

splitWithNewBackReferenceLengthOf	back to summary
private BlockLZ4CompressorOutputStream.Pair splitWithNewBackReferenceLengthOf(final int newBackReferenceLength)

writeLength	back to summary
private static void writeLength(int length, final OutputStream out) throws IOException

writeTo	back to summary
pack-priv void writeTo(final OutputStream out) throws IOException

public Class BlockLZ4CompressorOutputStream

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Class BlockLZ4CompressorOutputStream.Pair

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail