Modifier and Type	Class and Description
private static enum	FastLzDecompressor.State Current state of decompression.

Modifier and Type	Field and Description
private final BufferChecksum	checksum Underlying checksum calculator in use.
private int	chunkLength Length of current received chunk of data.
private int	currentChecksum Checksum value of current received chunk of data which has checksum.
private FastLzDecompressor.State	currentState
private boolean	hasChecksum Indicates is this chunk has checksum or not.
private boolean	isCompressed Indicates is this chunk compressed or not.
private int	originalLength Original of current received chunk of data.

Access	Constructor and Description
private	FastLzDecompressor(Checksum checksum)

Method Summary

Modifier and Type	Method and Description
public void	close() Implements io.netty5.handler.codec.compression.Decompressor.close. Close the decompressor.
public Buffer	decompress(Buffer the `Buffer` that contains the data to be decompressed. in, BufferAllocator the `BufferAllocator` that is used to allocate a new buffer (if needed) to write the decompressed bytes too. allocator) Implements io.netty5.handler.codec.compression.Decompressor.decompress. This method will read from the input `Buffer` and decompress into a new `Buffer` that will be allocated (if needed) from the `BufferAllocator`.
public boolean	isClosed() Implements io.netty5.handler.codec.compression.Decompressor.isClosed. Return `true` if the decompressor was closed, `false` otherwise.
public boolean	isFinished() Implements io.netty5.handler.codec.compression.Decompressor.isFinished. Returns true if the decompressor was finish.
public static Supplier<FastLzDecompressor>	Returns: the factory. newFactory() Creates the fastest FastLZ decompressor factory without checksum calculation.
public static Supplier<FastLzDecompressor>	Returns: the factory. newFactory(boolean 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 `java.util.zip.Adler32` as a default checksum calculator. validateChecksums) Creates a FastLZ decompressor factory with calculation of checksums as specified.
public static Supplier<FastLzDecompressor>	Returns: the factory. newFactory(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. checksum) Creates a FastLZ decompressor factory with specified checksum calculator.
private void	streamCorrupted(String message)

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

Field Detail

checksum	back to summary
private final BufferChecksum checksum Underlying checksum calculator in use.

chunkLength	back to summary
private int chunkLength Length of current received chunk of data.

currentChecksum	back to summary
private int currentChecksum Checksum value of current received chunk of data which has checksum.

currentState	back to summary
private FastLzDecompressor.State currentState

hasChecksum	back to summary
private boolean hasChecksum Indicates is this chunk has checksum or not.

isCompressed	back to summary
private boolean isCompressed Indicates is this chunk compressed or not.

originalLength	back to summary
private int originalLength Original of current received chunk of data. It is equal to `chunkLength` for non compressed chunks.

Constructor Detail

FastLzDecompressor	back to summary
private FastLzDecompressor(Checksum checksum)

Method Detail

close back to summary

close	back to summary
public void close() Implements io.netty5.handler.codec.compression.Decompressor.close. Doc from io.netty5.handler.codec.compression.Decompressor.close. Close the decompressor. After this method was called `isFinished()` will return `true` as well and it is not allowed to call `decompress(Buffer, BufferAllocator)` anymore. Annotations @Override

public void close()

Implements io.netty5.handler.codec.compression.Decompressor.close.

Doc from io.netty5.handler.codec.compression.Decompressor.close.

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

Annotations

@Override

decompress back to summary

decompress	back to summary
public Buffer decompress(Buffer in, BufferAllocator allocator) throws DecompressionException Implements io.netty5.handler.codec.compression.Decompressor.decompress. Doc from io.netty5.handler.codec.compression.Decompressor.decompress. 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: `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. Parameters in:Buffer the `Buffer` that contains the data to be decompressed. allocator:BufferAllocator the `BufferAllocator` that is used to allocate a new buffer (if needed) to write the decompressed bytes too. Returns:Buffer 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. Annotations @Override Exceptions DecompressionException: thrown if an decompression error was encountered or the decompressor was closed before.

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

Implements io.netty5.handler.codec.compression.Decompressor.decompress.

Doc from io.netty5.handler.codec.compression.Decompressor.decompress.

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:

isFinished()

false

input

something was returned

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

Parameters

in:Buffer: the Buffer that contains the data to be decompressed.
allocator:BufferAllocator: the BufferAllocator that is used to allocate a new buffer (if needed) to write the decompressed bytes too.

Returns:Buffer

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.

Annotations

@Override

Exceptions

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

isClosed back to summary

isClosed	back to summary
public boolean isClosed() Implements io.netty5.handler.codec.compression.Decompressor.isClosed. Doc from io.netty5.handler.codec.compression.Decompressor.isClosed. Return `true` if the decompressor was closed, `false` otherwise. Returns:boolean if `close()` was called. Annotations @Override

public boolean isClosed()

Implements io.netty5.handler.codec.compression.Decompressor.isClosed.

Doc from io.netty5.handler.codec.compression.Decompressor.isClosed.

Return true if the decompressor was closed, false otherwise.

Returns:boolean

if close() was called.

Annotations

@Override

isFinished back to summary

isFinished	back to summary
public boolean isFinished() Implements io.netty5.handler.codec.compression.Decompressor.isFinished. Doc from io.netty5.handler.codec.compression.Decompressor.isFinished. 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. Returns:boolean `true` if the decompressor is done with decompressing the stream. Annotations @Override

public boolean isFinished()

Implements io.netty5.handler.codec.compression.Decompressor.isFinished.

Doc from io.netty5.handler.codec.compression.Decompressor.isFinished.

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.

Returns:boolean

true if the decompressor is done with decompressing the stream.

Annotations

@Override

newFactory	back to summary
public static Supplier<FastLzDecompressor> newFactory() Creates the fastest FastLZ decompressor factory without checksum calculation. Returns:Supplier<FastLzDecompressor> the factory.

newFactory

back to summary

public static Supplier<FastLzDecompressor> newFactory()

Creates the fastest FastLZ decompressor factory without checksum calculation.

Returns:Supplier<FastLzDecompressor>: the factory.

newFactory back to summary

newFactory	back to summary
public static Supplier<FastLzDecompressor> newFactory(boolean validateChecksums) Creates a FastLZ decompressor factory with calculation of checksums as specified. Parameters validateChecksums:boolean 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 `java.util.zip.Adler32` as a default checksum calculator. Returns:Supplier<FastLzDecompressor> the factory.

public static Supplier<FastLzDecompressor> newFactory(boolean validateChecksums)

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

Parameters

validateChecksums:boolean: 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 java.util.zip.Adler32 as a default checksum calculator.

Returns:Supplier<FastLzDecompressor>

the factory.

newFactory back to summary

newFactory	back to summary
public static Supplier<FastLzDecompressor> newFactory(Checksum checksum) Creates a FastLZ decompressor factory with specified checksum calculator. Parameters checksum: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:Supplier<FastLzDecompressor> the factory.

public static Supplier<FastLzDecompressor> newFactory(Checksum checksum)

Creates a FastLZ decompressor factory with specified checksum calculator.

Parameters

checksum: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:Supplier<FastLzDecompressor>

the factory.

streamCorrupted	back to summary
private void streamCorrupted(String message)

io.netty5.handler.codec.compression back to summary

private final Enum FastLzDecompressor.State

Class Inheritance

extends Enum<FastLzDecompressor.State>

java.lang.Object
java.lang.Enum
io.netty5.handler.codec.compression.FastLzDecompressor.State

Current state of decompression.

Field Summary

Modifier and Type	Field and Description
public static final FastLzDecompressor.State	CLOSED
public static final FastLzDecompressor.State	CORRUPTED
public static final FastLzDecompressor.State	DECOMPRESS_DATA
public static final FastLzDecompressor.State	DONE
public static final FastLzDecompressor.State	INIT_BLOCK
public static final FastLzDecompressor.State	INIT_BLOCK_PARAMS

Constructor Summary

Access	Constructor and Description
private	State()

Method Summary

Modifier and Type	Method and Description
public static FastLzDecompressor.State	valueOf(String name)
public static FastLzDecompressor.State[]	values()

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

Field Detail

CLOSED	back to summary
public static final FastLzDecompressor.State CLOSED

CORRUPTED	back to summary
public static final FastLzDecompressor.State CORRUPTED

DECOMPRESS_DATA	back to summary
public static final FastLzDecompressor.State DECOMPRESS_DATA

DONE	back to summary
public static final FastLzDecompressor.State DONE

INIT_BLOCK	back to summary
public static final FastLzDecompressor.State INIT_BLOCK

INIT_BLOCK_PARAMS	back to summary
public static final FastLzDecompressor.State INIT_BLOCK_PARAMS

Constructor Detail

State	back to summary
private State()

Method Detail

valueOf	back to summary
public static FastLzDecompressor.State valueOf(String name)

values	back to summary
public static FastLzDecompressor.State[] values()

public final Class FastLzDecompressor

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Enum FastLzDecompressor.State

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail