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

Modifier and Type	Field and Description
private int	chunkLength Length of current received chunk of data.
private LzfDecompressor.State	currentState
private ChunkDecoder	decoder Underlying decoder in use.
private boolean	isCompressed Indicates is this chunk compressed or not.
private static final short	MAGIC_NUMBER Magic number of LZF chunk.
private int	originalLength Original length of current received chunk of data.
private BufferRecycler	recycler Object that handles details of buffer recycling.

Access	Constructor and Description
private	LzfDecompressor(boolean If `true` decoder will use `ChunkDecoder` that only uses standard JDK access methods, and should work on all Java platforms and JVMs. Otherwise decoder will try to use highly optimized `ChunkDecoder` implementation that uses Sun JDK's `sun.misc.Unsafe` class (which may be included by other JDK's as well). safeInstance) Creates a new LZF decompressor with specified decoding instance.

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`.
private Buffer	decompress(BufferAllocator allocator, byte[] inputArray, int offset, int len)
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<LzfDecompressor>	Returns: the factory. newFactory() Creates a new LZF decompressor factory with the most optimal available methods for underlying data access.
public static Supplier<LzfDecompressor>	Returns: the factory. newFactory(boolean If `true` decoder will use `ChunkDecoder` that only uses standard JDK access methods, and should work on all Java platforms and JVMs. Otherwise decoder will try to use highly optimized `ChunkDecoder` implementation that uses Sun JDK's `sun.misc.Unsafe` class (which may be included by other JDK's as well). safeInstance) Creates a new LZF decompressor factory with specified decoding instance.
private void	streamCorrupted(String message)

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

Field Detail

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

currentState	back to summary
private LzfDecompressor.State currentState

decoder	back to summary
private ChunkDecoder decoder Underlying decoder in use.

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

MAGIC_NUMBER	back to summary
private static final short MAGIC_NUMBER Magic number of LZF chunk.

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

recycler	back to summary
private BufferRecycler recycler Object that handles details of buffer recycling.

Constructor Detail

LzfDecompressor back to summary

LzfDecompressor	back to summary
private LzfDecompressor(boolean safeInstance) Creates a new LZF decompressor with specified decoding instance. Parameters safeInstance:boolean If `true` decoder will use `ChunkDecoder` that only uses standard JDK access methods, and should work on all Java platforms and JVMs. Otherwise decoder will try to use highly optimized `ChunkDecoder` implementation that uses Sun JDK's `sun.misc.Unsafe` class (which may be included by other JDK's as well).

private LzfDecompressor(boolean safeInstance)

Creates a new LZF decompressor with specified decoding instance.

Parameters

safeInstance:boolean: If true decoder will use ChunkDecoder that only uses standard JDK access methods, and should work on all Java platforms and JVMs. Otherwise decoder will try to use highly optimized ChunkDecoder implementation that uses Sun JDK's sun.misc.Unsafe class (which may be included by other JDK's as well).

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.

decompress	back to summary
private Buffer decompress(BufferAllocator allocator, byte[] inputArray, int offset, int len) throws LZFException

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

newFactory	back to summary
public static Supplier<LzfDecompressor> newFactory() Creates a new LZF decompressor factory with the most optimal available methods for underlying data access. It will "unsafe" instance if one can be used on current JVM. It should be safe to call this constructor as implementations are dynamically loaded; however, on some non-standard platforms it may be necessary to use `LzfDecompressor(boolean)` with `true` param. Returns:Supplier<LzfDecompressor> the factory.

public static Supplier<LzfDecompressor> newFactory()

Creates a new LZF decompressor factory with the most optimal available methods for underlying data access. It will "unsafe" instance if one can be used on current JVM. It should be safe to call this constructor as implementations are dynamically loaded; however, on some non-standard platforms it may be necessary to use LzfDecompressor(boolean) with true param.

Returns:Supplier<LzfDecompressor>: the factory.

newFactory back to summary

newFactory	back to summary
public static Supplier<LzfDecompressor> newFactory(boolean safeInstance) Creates a new LZF decompressor factory with specified decoding instance. Parameters safeInstance:boolean If `true` decoder will use `ChunkDecoder` that only uses standard JDK access methods, and should work on all Java platforms and JVMs. Otherwise decoder will try to use highly optimized `ChunkDecoder` implementation that uses Sun JDK's `sun.misc.Unsafe` class (which may be included by other JDK's as well). Returns:Supplier<LzfDecompressor> the factory.

public static Supplier<LzfDecompressor> newFactory(boolean safeInstance)

Creates a new LZF decompressor factory with specified decoding instance.

Parameters

safeInstance:boolean: If true decoder will use ChunkDecoder that only uses standard JDK access methods, and should work on all Java platforms and JVMs. Otherwise decoder will try to use highly optimized ChunkDecoder implementation that uses Sun JDK's sun.misc.Unsafe class (which may be included by other JDK's as well).

Returns:Supplier<LzfDecompressor>

the factory.

streamCorrupted	back to summary
private void streamCorrupted(String message)

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

private final Enum LzfDecompressor.State

Class Inheritance

extends Enum<LzfDecompressor.State>

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

Current state of decompression.

Field Summary

Modifier and Type	Field and Description
public static final LzfDecompressor.State	CLOSED
public static final LzfDecompressor.State	CORRUPTED
public static final LzfDecompressor.State	DECOMPRESS_DATA
public static final LzfDecompressor.State	FINISHED
public static final LzfDecompressor.State	INIT_BLOCK
public static final LzfDecompressor.State	INIT_ORIGINAL_LENGTH

Constructor Summary

Access	Constructor and Description
private	State()

Method Summary

Modifier and Type	Method and Description
public static LzfDecompressor.State	valueOf(String name)
public static LzfDecompressor.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 LzfDecompressor.State CLOSED

CORRUPTED	back to summary
public static final LzfDecompressor.State CORRUPTED

DECOMPRESS_DATA	back to summary
public static final LzfDecompressor.State DECOMPRESS_DATA

FINISHED	back to summary
public static final LzfDecompressor.State FINISHED

INIT_BLOCK	back to summary
public static final LzfDecompressor.State INIT_BLOCK

INIT_ORIGINAL_LENGTH	back to summary
public static final LzfDecompressor.State INIT_ORIGINAL_LENGTH

Constructor Detail

State	back to summary
private State()

Method Detail

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

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

public final Class LzfDecompressor

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Enum LzfDecompressor.State

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail