Modifier and Type	Class and Description
private static enum	SnappyDecompressor.ChunkType
private static enum	SnappyDecompressor.State

Modifier and Type	Field and Description
private static final int	MAX_COMPRESSED_CHUNK_SIZE
private static final int	MAX_DECOMPRESSED_DATA_SIZE
private static final int	MAX_UNCOMPRESSED_DATA_SIZE
private int	numBytesToSkip
private final Snappy	snappy
private static final int	SNAPPY_IDENTIFIER_LEN
private boolean	started
private SnappyDecompressor.State	state
private final boolean	validateChecksums

Access	Constructor and Description
private	SnappyDecompressor(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 validateChecksums) Creates a new snappy decompressor with validation of checksums as specified.

Method Summary

Modifier and Type	Method and Description
private static void	checkByte(byte actual, byte expect)
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.
private static SnappyDecompressor.ChunkType	Returns: The appropriate `ChunkType`, defaulting to `ChunkType#RESERVED_UNSKIPPABLE` mapChunkType(byte The tag byte extracted from the stream type) Decodes the chunk type from the type tag byte.
public static Supplier<SnappyDecompressor>	Returns: the factory. newFactory() Creates a new snappy decompressor factory with validation of checksums turned OFF.
public static Supplier<SnappyDecompressor>	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 validateChecksums) Creates a new snappy decompressor factory with validation of checksums as specified.
private void	streamCorrupted(String message)

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

Field Detail

MAX_COMPRESSED_CHUNK_SIZE	back to summary
private static final int MAX_COMPRESSED_CHUNK_SIZE

MAX_DECOMPRESSED_DATA_SIZE	back to summary
private static final int MAX_DECOMPRESSED_DATA_SIZE

MAX_UNCOMPRESSED_DATA_SIZE	back to summary
private static final int MAX_UNCOMPRESSED_DATA_SIZE

numBytesToSkip	back to summary
private int numBytesToSkip

snappy	back to summary
private final Snappy snappy

SNAPPY_IDENTIFIER_LEN	back to summary
private static final int SNAPPY_IDENTIFIER_LEN

started	back to summary
private boolean started

state	back to summary
private SnappyDecompressor.State state

validateChecksums	back to summary
private final boolean validateChecksums

Constructor Detail

SnappyDecompressor back to summary

SnappyDecompressor	back to summary
private SnappyDecompressor(boolean validateChecksums) Creates a new snappy decompressor with validation 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

private SnappyDecompressor(boolean validateChecksums)

Creates a new snappy decompressor with validation 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

Method Detail

checkByte	back to summary
private static void checkByte(byte actual, byte expect)

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

mapChunkType back to summary

mapChunkType	back to summary
private static SnappyDecompressor.ChunkType mapChunkType(byte type) Decodes the chunk type from the type tag byte. Parameters type:byte The tag byte extracted from the stream Returns:SnappyDecompressor.ChunkType The appropriate `ChunkType`, defaulting to `ChunkType#RESERVED_UNSKIPPABLE`

private static SnappyDecompressor.ChunkType mapChunkType(byte type)

Decodes the chunk type from the type tag byte.

Parameters

type:byte: The tag byte extracted from the stream

Returns:SnappyDecompressor.ChunkType

The appropriate ChunkType, defaulting to ChunkType#RESERVED_UNSKIPPABLE

newFactory back to summary

newFactory	back to summary
public static Supplier<SnappyDecompressor> newFactory() Creates a new snappy decompressor factory with validation of checksums turned OFF. To turn checksum validation on, please use the alternate `SnappyDecompressor(boolean)` constructor. Returns:Supplier<SnappyDecompressor> the factory.

public static Supplier<SnappyDecompressor> newFactory()

Creates a new snappy decompressor factory with validation of checksums turned OFF. To turn checksum validation on, please use the alternate SnappyDecompressor(boolean) constructor.

Returns:Supplier<SnappyDecompressor>: the factory.

newFactory back to summary

newFactory	back to summary
public static Supplier<SnappyDecompressor> newFactory(boolean validateChecksums) Creates a new snappy decompressor factory with validation 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 Returns:Supplier<SnappyDecompressor> the factory.

public static Supplier<SnappyDecompressor> newFactory(boolean validateChecksums)

Creates a new snappy decompressor factory with validation 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

Returns:Supplier<SnappyDecompressor>

the factory.

streamCorrupted	back to summary
private void streamCorrupted(String message)

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

private final Enum SnappyDecompressor.ChunkType

Class Inheritance

extends Enum<SnappyDecompressor.ChunkType>

java.lang.Object
java.lang.Enum
io.netty5.handler.codec.compression.SnappyDecompressor.ChunkType

Field Summary

Modifier and Type	Field and Description
public static final SnappyDecompressor.ChunkType	COMPRESSED_DATA
public static final SnappyDecompressor.ChunkType	CORRUPTED
public static final SnappyDecompressor.ChunkType	FINISHED
public static final SnappyDecompressor.ChunkType	RESERVED_SKIPPABLE
public static final SnappyDecompressor.ChunkType	RESERVED_UNSKIPPABLE
public static final SnappyDecompressor.ChunkType	STREAM_IDENTIFIER
public static final SnappyDecompressor.ChunkType	UNCOMPRESSED_DATA

Constructor Summary

Access	Constructor and Description
private	ChunkType()

Method Summary

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

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

Field Detail

COMPRESSED_DATA	back to summary
public static final SnappyDecompressor.ChunkType COMPRESSED_DATA

CORRUPTED	back to summary
public static final SnappyDecompressor.ChunkType CORRUPTED

FINISHED	back to summary
public static final SnappyDecompressor.ChunkType FINISHED

RESERVED_SKIPPABLE	back to summary
public static final SnappyDecompressor.ChunkType RESERVED_SKIPPABLE

RESERVED_UNSKIPPABLE	back to summary
public static final SnappyDecompressor.ChunkType RESERVED_UNSKIPPABLE

STREAM_IDENTIFIER	back to summary
public static final SnappyDecompressor.ChunkType STREAM_IDENTIFIER

UNCOMPRESSED_DATA	back to summary
public static final SnappyDecompressor.ChunkType UNCOMPRESSED_DATA

Constructor Detail

ChunkType	back to summary
private ChunkType()

Method Detail

valueOf	back to summary
public static SnappyDecompressor.ChunkType valueOf(String name)

values	back to summary
public static SnappyDecompressor.ChunkType[] values()

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

private final Enum SnappyDecompressor.State

Class Inheritance

extends Enum<SnappyDecompressor.State>

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

Field Summary

Modifier and Type	Field and Description
public static final SnappyDecompressor.State	CLOSED
public static final SnappyDecompressor.State	CORRUPTED
public static final SnappyDecompressor.State	DECODING
public static final SnappyDecompressor.State	FINISHED

Constructor Summary

Access	Constructor and Description
private	State()

Method Summary

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

CORRUPTED	back to summary
public static final SnappyDecompressor.State CORRUPTED

DECODING	back to summary
public static final SnappyDecompressor.State DECODING

FINISHED	back to summary
public static final SnappyDecompressor.State FINISHED

Constructor Detail

State	back to summary
private State()

Method Detail

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

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

public final Class SnappyDecompressor

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Enum SnappyDecompressor.ChunkType

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Enum SnappyDecompressor.State

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail