Top Description Inners Fields Constructors Methods
io.netty5.handler.codec.compression

public final Class BrotliCompressor

extends Object
implements Compressor
Class Inheritance
All Implemented Interfaces
io.netty5.handler.codec.compression.Compressor, java.lang.AutoCloseable
Imports
com.aayushatharva.brotli4j.encoder.Encoder, io.netty5.buffer.Buffer, .BufferAllocator, java.io.IOException, java.util.Objects, java.util.function.Supplier
Compress a Buffer with the brotli format. See brotli.

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static enum
BrotliCompressor.State

Field Summary

Modifier and TypeField and Description
private final Encoder.Parameters
parameters

private BrotliCompressor.State
state

Constructor Summary

AccessConstructor and Description
private
BrotliCompressor(Encoder.Parameters
Encoder.Parameters Instance
parameters)

Create a new BrotliCompressor Instance

Method Summary

Modifier and TypeMethod and Description
public void
close()

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

# Close the compressor.
public Buffer
compress(Buffer
the Buffer that contains the data to be compressed.
input, 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.
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<BrotliCompressor>

Returns:

the factory.
newFactory(Encoder.Parameters
Encoder.Parameters Instance
parameters)

Create a new BrotliCompressor factory

public static Supplier<BrotliCompressor>

Returns:

the factory.
newFactory(BrotliOptions
BrotliOptions to use.
brotliOptions)

Create a new BrotliCompressor factory

public static Supplier<BrotliCompressor>

Returns:

the factory.
newFactory()

Create a new BrotliCompressor factory with Encoder.Parameters#setQuality(int) set to 4 and Encoder.Parameters#setMode(Encoder.Mode) set to Encoder.Mode#TEXT

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

parametersback to summary
private final Encoder.Parameters parameters
stateback to summary
private BrotliCompressor.State state

Constructor Detail

BrotliCompressorback to summary
private BrotliCompressor(Encoder.Parameters parameters)

Create a new BrotliCompressor Instance

Parameters
parameters:Encoder.Parameters

Encoder.Parameters Instance

Method Detail

closeback 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
compressback to summary
public Buffer compress(Buffer input, 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
input: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.
finishback 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
isClosedback 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
isFinishedback 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
newFactoryback to summary
public static Supplier<BrotliCompressor> newFactory(Encoder.Parameters parameters)

Create a new BrotliCompressor factory

Parameters
parameters:Encoder.Parameters

Encoder.Parameters Instance

Returns:Supplier<BrotliCompressor>

the factory.

newFactoryback to summary
public static Supplier<BrotliCompressor> newFactory(BrotliOptions brotliOptions)

Create a new BrotliCompressor factory

Parameters
brotliOptions:BrotliOptions

BrotliOptions to use.

Returns:Supplier<BrotliCompressor>

the factory.

newFactoryback to summary
public static Supplier<BrotliCompressor> newFactory()

Create a new BrotliCompressor factory with Encoder.Parameters#setQuality(int) set to 4 and Encoder.Parameters#setMode(Encoder.Mode) set to Encoder.Mode#TEXT

Returns:Supplier<BrotliCompressor>

the factory.

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

private final Enum BrotliCompressor.State

extends Enum<BrotliCompressor.State>
Class Inheritance

Field Summary

Modifier and TypeField and Description
public static final BrotliCompressor.State
CLOSED

public static final BrotliCompressor.State
FINISHED

public static final BrotliCompressor.State
PROCESSING

Constructor Summary

AccessConstructor and Description
private
State()

Method Summary

Modifier and TypeMethod and Description
public static BrotliCompressor.State
valueOf(String name)

public static BrotliCompressor.State[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

CLOSEDback to summary
public static final BrotliCompressor.State CLOSED
FINISHEDback to summary
public static final BrotliCompressor.State FINISHED
PROCESSINGback to summary
public static final BrotliCompressor.State PROCESSING

Constructor Detail

Stateback to summary
private State()

Method Detail

valueOfback to summary
public static BrotliCompressor.State valueOf(String name)
valuesback to summary
public static BrotliCompressor.State[] values()