Modifier and Type	Class and Description
private static enum	Bzip2Compressor.CompressorState
private static enum	Bzip2Compressor.State Current state of stream.

Modifier and Type	Field and Description
private Bzip2BlockCompressor	blockCompressor The compressor for the current block.
private Bzip2Compressor.CompressorState	compressorState
private Bzip2Compressor.State	currentState
private final int	streamBlockSize The declared maximum block size of the stream (before final run-length decoding).
private int	streamCRC The merged CRC of all blocks compressed so far.
private final Bzip2BitWriter	writer A writer that provides bit-level writes.

Access	Constructor and Description
private	Bzip2Compressor(final int The Bzip2 block size as a multiple of 100,000 bytes (minimum `1`, maximum `9`). Larger block sizes require more memory for both compression and decompression, but give better compression ratios. `9` will usually be the best value to use. blockSizeMultiplier) Creates a new bzip2 compressor with the specified `blockSizeMultiplier`.

Method Summary

Modifier and Type	Method and Description
public void	close() Implements io.netty5.handler.codec.compression.Compressor.close. # Close the compressor.
private void	closeBlock(Buffer out) Close current block and update `streamCRC`.
public Buffer	compress(Buffer the `Buffer` that contains the data to be compressed. in, BufferAllocator the `BufferAllocator` that is used to allocate a new buffer (if needed) to write the compressed bytes too. allocator) Implements io.netty5.handler.codec.compression.Compressor.compress. This method will read from the input `Buffer` and compress into a new `Buffer` that will be allocated (if needed) from the `BufferAllocator`.
private Buffer	compressData(Buffer in, BufferAllocator allocator)
public Buffer	finish(BufferAllocator allocator) Implements io.netty5.handler.codec.compression.Compressor.finish. By calling this method we signal that the compression stream is marked as finish.
public boolean	isClosed() Implements io.netty5.handler.codec.compression.Compressor.isClosed. Return `true` if the decompressor was closed, `false` otherwise.
public boolean	isFinished() Implements io.netty5.handler.codec.compression.Compressor.isFinished. Returns true if the compressor was finished or closed.
public static Supplier<Bzip2Compressor>	Returns: the factory. newFactory() Creates a new bzip2 compressor factory with the maximum (900,000 byte) block size.
public static Supplier<Bzip2Compressor>	Returns: the factory. newFactory(final int The Bzip2 block size as a multiple of 100,000 bytes (minimum `1`, maximum `9`). Larger block sizes require more memory for both compression and decompression, but give better compression ratios. `9` will usually be the best value to use. blockSizeMultiplier) Creates a new bzip2 compressor factory with the specified `blockSizeMultiplier`.

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

Field Detail

blockCompressor	back to summary
private Bzip2BlockCompressor blockCompressor The compressor for the current block.

compressorState	back to summary
private Bzip2Compressor.CompressorState compressorState

currentState	back to summary
private Bzip2Compressor.State currentState

streamBlockSize	back to summary
private final int streamBlockSize The declared maximum block size of the stream (before final run-length decoding).

streamCRC	back to summary
private int streamCRC The merged CRC of all blocks compressed so far.

writer	back to summary
private final Bzip2BitWriter writer A writer that provides bit-level writes.

Constructor Detail

Bzip2Compressor back to summary

Bzip2Compressor	back to summary
private Bzip2Compressor(final int blockSizeMultiplier) Creates a new bzip2 compressor with the specified `blockSizeMultiplier`. Parameters blockSizeMultiplier:int The Bzip2 block size as a multiple of 100,000 bytes (minimum `1`, maximum `9`). Larger block sizes require more memory for both compression and decompression, but give better compression ratios. `9` will usually be the best value to use.

private Bzip2Compressor(final int blockSizeMultiplier)

Creates a new bzip2 compressor with the specified blockSizeMultiplier.

Parameters

blockSizeMultiplier:int: The Bzip2 block size as a multiple of 100,000 bytes (minimum 1, maximum 9). Larger block sizes require more memory for both compression and decompression, but give better compression ratios. 9 will usually be the best value to use.

Method Detail

close back to summary

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

public void close()

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

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

# Close the compressor. After this method was called isFinished() will return true as well and it is not allowed to call compress(Buffer, BufferAllocator) or finish(BufferAllocator) anymore -

Annotations

@Override

closeBlock	back to summary
private void closeBlock(Buffer out) Close current block and update `streamCRC`.

compress back to summary

compress	back to summary
public Buffer compress(Buffer in, BufferAllocator allocator) throws CompressionException Implements io.netty5.handler.codec.compression.Compressor.compress. Doc from io.netty5.handler.codec.compression.Compressor.compress. This method will read from the input `Buffer` and compress into a new `Buffer` that will be allocated (if needed) from the `BufferAllocator`. This method is expected to consume all data from the input but not take ownership. The caller is responsible to release the input buffer after this method returns. Parameters in:Buffer the `Buffer` that contains the data to be compressed. allocator:BufferAllocator the `BufferAllocator` that is used to allocate a new buffer (if needed) to write the compressed bytes too. Returns:Buffer the `Buffer` that contains the compressed data. The caller of this method takes ownership of the buffer. The return value will never be `null`. Annotations @Override Exceptions CompressionException: thrown if an compression error was encountered or the compressor was closed already.

public Buffer compress(Buffer in, BufferAllocator allocator) throws CompressionException

Implements io.netty5.handler.codec.compression.Compressor.compress.

Doc from io.netty5.handler.codec.compression.Compressor.compress.

This method will read from the input Buffer and compress into a new Buffer that will be allocated (if needed) from the BufferAllocator. This method is expected to consume all data from the input but not take ownership. The caller is responsible to release the input buffer after this method returns.

Parameters

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

Returns:Buffer

the Buffer that contains the compressed data. The caller of this method takes ownership of the buffer. The return value will never be null.

Annotations

@Override

Exceptions

CompressionException:: thrown if an compression error was encountered or the compressor was closed already.

compressData	back to summary
private Buffer compressData(Buffer in, BufferAllocator allocator)

finish back to summary

finish	back to summary
public Buffer finish(BufferAllocator allocator) Implements io.netty5.handler.codec.compression.Compressor.finish. Doc from io.netty5.handler.codec.compression.Compressor.finish. By calling this method we signal that the compression stream is marked as finish. The returned `Buffer` might contain a "trailer" which marks the end of the stream. Returns:Buffer the `Buffer` which represent the end of the compression stream, which might be empty if the compressor don't need a trailer to signal the end. The caller of this method takes ownership of the buffer. The return value will never be `null`. Annotations @Override

public Buffer finish(BufferAllocator allocator)

Implements io.netty5.handler.codec.compression.Compressor.finish.

Doc from io.netty5.handler.codec.compression.Compressor.finish.

By calling this method we signal that the compression stream is marked as finish. The returned Buffer might contain a "trailer" which marks the end of the stream.

Returns:Buffer

the Buffer which represent the end of the compression stream, which might be empty if the compressor don't need a trailer to signal the end. The caller of this method takes ownership of the buffer. The return value will never be null.

Annotations

@Override

isClosed back to summary

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

public boolean isClosed()

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

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

Return true if the decompressor was closed, false otherwise.

Returns:boolean

true if the decompressor was closed, false otherwise.

Annotations

@Override

isFinished back to summary

isFinished	back to summary
public boolean isFinished() Implements io.netty5.handler.codec.compression.Compressor.isFinished. Doc from io.netty5.handler.codec.compression.Compressor.isFinished. Returns true if the compressor was finished or closed. This might happen because someone explicit called `finish(BufferAllocator)` / `close()` or the compressor implementation did decide to close itself due a compression error which can't be recovered. After `isFinished()` returns `true` the `compress(Buffer, BufferAllocator)` method will just return an empty buffer without consuming anything from its input buffer. Returns:boolean `true` if the compressor was marked as finished, `false` otherwise. Annotations @Override

public boolean isFinished()

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

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

Returns true if the compressor was finished or closed. This might happen because someone explicit called finish(BufferAllocator) / close() or the compressor implementation did decide to close itself due a compression error which can't be recovered. After isFinished() returns true the compress(Buffer, BufferAllocator) method will just return an empty buffer without consuming anything from its input buffer.

Returns:boolean

true if the compressor was marked as finished, false otherwise.

Annotations

@Override

newFactory	back to summary
public static Supplier<Bzip2Compressor> newFactory() Creates a new bzip2 compressor factory with the maximum (900,000 byte) block size. Returns:Supplier<Bzip2Compressor> the factory.

newFactory

back to summary

public static Supplier<Bzip2Compressor> newFactory()

Creates a new bzip2 compressor factory with the maximum (900,000 byte) block size.

Returns:Supplier<Bzip2Compressor>: the factory.

newFactory back to summary

newFactory	back to summary
public static Supplier<Bzip2Compressor> newFactory(final int blockSizeMultiplier) Creates a new bzip2 compressor factory with the specified `blockSizeMultiplier`. Parameters blockSizeMultiplier:int The Bzip2 block size as a multiple of 100,000 bytes (minimum `1`, maximum `9`). Larger block sizes require more memory for both compression and decompression, but give better compression ratios. `9` will usually be the best value to use. Returns:Supplier<Bzip2Compressor> the factory.

public static Supplier<Bzip2Compressor> newFactory(final int blockSizeMultiplier)

Creates a new bzip2 compressor factory with the specified blockSizeMultiplier.

Parameters

blockSizeMultiplier:int: The Bzip2 block size as a multiple of 100,000 bytes (minimum 1, maximum 9). Larger block sizes require more memory for both compression and decompression, but give better compression ratios. 9 will usually be the best value to use.

Returns:Supplier<Bzip2Compressor>

the factory.

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

private final Enum Bzip2Compressor.CompressorState

Class Inheritance

extends Enum<Bzip2Compressor.CompressorState>

java.lang.Object
java.lang.Enum
io.netty5.handler.codec.compression.Bzip2Compressor.CompressorState

Field Summary

Modifier and Type	Field and Description
public static final Bzip2Compressor.CompressorState	CLOSED
public static final Bzip2Compressor.CompressorState	FINISHED
public static final Bzip2Compressor.CompressorState	PROCESSING

Constructor Summary

Access	Constructor and Description
private	CompressorState()

Method Summary

Modifier and Type	Method and Description
public static Bzip2Compressor.CompressorState	valueOf(String name)
public static Bzip2Compressor.CompressorState[]	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 Bzip2Compressor.CompressorState CLOSED

FINISHED	back to summary
public static final Bzip2Compressor.CompressorState FINISHED

PROCESSING	back to summary
public static final Bzip2Compressor.CompressorState PROCESSING

Constructor Detail

CompressorState	back to summary
private CompressorState()

Method Detail

valueOf	back to summary
public static Bzip2Compressor.CompressorState valueOf(String name)

values	back to summary
public static Bzip2Compressor.CompressorState[] values()

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

private final Enum Bzip2Compressor.State

Class Inheritance

extends Enum<Bzip2Compressor.State>

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

Current state of stream.

Field Summary

Modifier and Type	Field and Description
public static final Bzip2Compressor.State	CLOSE_BLOCK
public static final Bzip2Compressor.State	INIT
public static final Bzip2Compressor.State	INIT_BLOCK
public static final Bzip2Compressor.State	WRITE_DATA

Constructor Summary

Access	Constructor and Description
private	State()

Method Summary

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

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

Field Detail

CLOSE_BLOCK	back to summary
public static final Bzip2Compressor.State CLOSE_BLOCK

INIT	back to summary
public static final Bzip2Compressor.State INIT

INIT_BLOCK	back to summary
public static final Bzip2Compressor.State INIT_BLOCK

WRITE_DATA	back to summary
public static final Bzip2Compressor.State WRITE_DATA

Constructor Detail

State	back to summary
private State()

Method Detail

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

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

public final Class Bzip2Compressor

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Enum Bzip2Compressor.CompressorState

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Enum Bzip2Compressor.State

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail