Module io.netty5.codec

Package io.netty5.handler.codec.compression

Class FastLzDecompressor

java.lang.Object

io.netty5.handler.codec.compression.FastLzDecompressor

All Implemented Interfaces:

Decompressor, AutoCloseable

public final class FastLzDecompressor
extends Object
implements Decompressor

Uncompresses a Buffer encoded by FastLzCompressor using the FastLZ algorithm. See FastLZ format.

Method Summary

Modifier and Type	Method	Description
void	close()	Close the decompressor.
Buffer	decompress(Buffer in, BufferAllocator allocator)	This method will read from the input Buffer and decompress into a new Buffer that will be allocated (if needed) from the BufferAllocator.
boolean	isClosed()	Return true if the decompressor was closed, false otherwise.
boolean	isFinished()	Returns true if the decompressor was finish.
static Supplier<FastLzDecompressor>	newFactory()	Creates the fastest FastLZ decompressor factory without checksum calculation.
static Supplier<FastLzDecompressor>	newFactory(boolean validateChecksums)	Creates a FastLZ decompressor factory with calculation of checksums as specified.
static Supplier<FastLzDecompressor>	newFactory(Checksum checksum)	Creates a FastLZ decompressor factory with specified checksum calculator.

Methods inherited from class java.lang.Object

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

Method Detail

newFactory

public static Supplier<FastLzDecompressor> newFactory()

Creates the fastest FastLZ decompressor factory without checksum calculation.

Returns:

the factory.

newFactory

public static Supplier<FastLzDecompressor> newFactory(boolean validateChecksums)

Creates a FastLZ decompressor factory with calculation of checksums as specified.

Parameters:

validateChecksums - If true, the checksum field will be validated against the actual uncompressed data, and if the checksums do not match, a suitable DecompressionException will be thrown. Note, that in this case decoder will use Adler32 as a default checksum calculator.

Returns:

the factory.

newFactory

public static Supplier<FastLzDecompressor> newFactory(Checksum checksum)

Creates a FastLZ decompressor factory with specified checksum calculator.

Parameters:

checksum - the Checksum instance to use to check data for integrity. You may set null if you do not want to validate checksum of each block.

Returns:

the factory.

decompress

public Buffer decompress(Buffer in,
                         BufferAllocator allocator)
                  throws DecompressionException

Description copied from interface: Decompressor

This method will read from the input Buffer and decompress into a new Buffer that will be allocated (if needed) from the BufferAllocator. If there is not enough readable data in the Buffer to process it will return null. This method should be called in a loop as long:

Decompressor.isFinished() is false

something was read from the input

something was returned

Otherwise this method should be called again once there is more data in the input buffer.

Specified by:

decompress in interface Decompressor

Parameters:

in - the Buffer that contains the data to be decompressed.

allocator - the BufferAllocator that is used to allocate a new buffer (if needed) to write the decompressed bytes too.

Returns:

the Buffer that contains the decompressed data. The caller of this method takes ownership of the buffer. The return value will be null if there is not enough data readable in the input to make any progress. In this case the user should call it again once there is more data ready to be consumed.

Throws:

DecompressionException - thrown if an decompression error was encountered or the decompressor was closed before.

isFinished

public boolean isFinished()

Description copied from interface: Decompressor

Returns true if the decompressor was finish. This might be because the decompressor was explicitly closed or the end of the compressed stream was detected.

Specified by:

isFinished in interface Decompressor

Returns:

true if the decompressor is done with decompressing the stream.

isClosed

public boolean isClosed()

Description copied from interface: Decompressor

Return true if the decompressor was closed, false otherwise.

Specified by:

isClosed in interface Decompressor

Returns:

if Decompressor.close() was called.

close

public void close()

Description copied from interface: Decompressor

Close the decompressor. After this method was called Decompressor.isFinished() will return true as well and it is not allowed to call Decompressor.decompress(Buffer, BufferAllocator) anymore.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Decompressor