Netty/Codec 4.1.107.Final · io.netty.handler.codec.compression.StandardCompressionOptions

Access	Constructor and Description
private	StandardCompressionOptions()

Method Summary

Modifier and Type	Method and Description
public static BrotliOptions	brotli() Default implementation of `BrotliOptions` with `Encoder.Parameters#setQuality(int)` set to 4 and `Encoder.Parameters#setMode(Encoder.Mode)` set to `Encoder.Mode#TEXT`
public static BrotliOptions	brotli(Encoder.Parameters `Encoder.Parameters` Instance parameters) Create a new `BrotliOptions`
public static DeflateOptions	deflate() Default implementation of `DeflateOptions` with `compressionLevel` set to 6, `windowBits` set to 15 and `memLevel` set to 8.
public static DeflateOptions	deflate(int `1` yields the fastest compression and `9` yields the best compression. `0` means no compression. The default compression level is `6`. compressionLevel, int The base two logarithm of the size of the history buffer. The value should be in the range `9` to `15` inclusive. Larger values result in better compression at the expense of memory usage. The default value is `15`. windowBits, int How much memory should be allocated for the internal compression state. `1` uses minimum memory and `9` uses maximum memory. Larger values result in better and faster compression at the expense of memory usage. The default value is `8` memLevel) Create a new `DeflateOptions` Instance
public static GzipOptions	gzip() Default implementation of `GzipOptions` with `compressionLevel()` set to 6, `windowBits()` set to 15 and `memLevel()` set to 8.
public static GzipOptions	gzip(int `1` yields the fastest compression and `9` yields the best compression. `0` means no compression. The default compression level is `6`. compressionLevel, int The base two logarithm of the size of the history buffer. The value should be in the range `9` to `15` inclusive. Larger values result in better compression at the expense of memory usage. The default value is `15`. windowBits, int How much memory should be allocated for the internal compression state. `1` uses minimum memory and `9` uses maximum memory. Larger values result in better and faster compression at the expense of memory usage. The default value is `8` memLevel) Create a new `GzipOptions` Instance
public static SnappyOptions	snappy() Create a new `SnappyOptions`
public static ZstdOptions	zstd() Default implementation of `ZstdOptions` with{compressionLevel(int)} set to `ZstdConstants#DEFAULT_COMPRESSION_LEVEL`,`ZstdConstants#DEFAULT_BLOCK_SIZE`, `ZstdConstants#MAX_BLOCK_SIZE`
public static ZstdOptions	zstd(int specifies the level of the compression compressionLevel, int is used to calculate the compressionLevel blockSize, int specifies the size of the largest compressed object maxEncodeSize) Create a new `ZstdOptions`

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

StandardCompressionOptions	back to summary
private StandardCompressionOptions()

Method Detail

brotli	back to summary
public static BrotliOptions brotli() Default implementation of `BrotliOptions` with `Encoder.Parameters#setQuality(int)` set to 4 and `Encoder.Parameters#setMode(Encoder.Mode)` set to `Encoder.Mode#TEXT`

brotli back to summary

brotli	back to summary
public static BrotliOptions brotli(Encoder.Parameters parameters) Create a new `BrotliOptions` Parameters parameters:Encoder.Parameters `Encoder.Parameters` Instance Exceptions NullPointerException: If `Encoder.Parameters` is `null`

public static BrotliOptions brotli(Encoder.Parameters parameters)

Create a new BrotliOptions

Parameters

parameters:Encoder.Parameters: Encoder.Parameters Instance

Exceptions

NullPointerException:: If Encoder.Parameters is null

deflate	back to summary
public static DeflateOptions deflate() Default implementation of `DeflateOptions` with `compressionLevel` set to 6, `windowBits` set to 15 and `memLevel` set to 8.

deflate back to summary

deflate	back to summary
public static DeflateOptions deflate(int compressionLevel, int windowBits, int memLevel) Create a new `DeflateOptions` Instance Parameters compressionLevel:int `1` yields the fastest compression and `9` yields the best compression. `0` means no compression. The default compression level is `6`. windowBits:int The base two logarithm of the size of the history buffer. The value should be in the range `9` to `15` inclusive. Larger values result in better compression at the expense of memory usage. The default value is `15`. memLevel:int How much memory should be allocated for the internal compression state. `1` uses minimum memory and `9` uses maximum memory. Larger values result in better and faster compression at the expense of memory usage. The default value is `8`

public static DeflateOptions deflate(int compressionLevel, int windowBits, int memLevel)

Create a new DeflateOptions Instance

Parameters

compressionLevel:int: 1 yields the fastest compression and 9 yields the best compression. 0 means no compression. The default compression level is 6.
windowBits:int: The base two logarithm of the size of the history buffer. The value should be in the range 9 to 15 inclusive. Larger values result in better compression at the expense of memory usage. The default value is 15.
memLevel:int: How much memory should be allocated for the internal compression state. 1 uses minimum memory and 9 uses maximum memory. Larger values result in better and faster compression at the expense of memory usage. The default value is 8

gzip	back to summary
public static GzipOptions gzip() Default implementation of `GzipOptions` with `compressionLevel()` set to 6, `windowBits()` set to 15 and `memLevel()` set to 8.

gzip back to summary

gzip	back to summary
public static GzipOptions gzip(int compressionLevel, int windowBits, int memLevel) Create a new `GzipOptions` Instance Parameters compressionLevel:int `1` yields the fastest compression and `9` yields the best compression. `0` means no compression. The default compression level is `6`. windowBits:int The base two logarithm of the size of the history buffer. The value should be in the range `9` to `15` inclusive. Larger values result in better compression at the expense of memory usage. The default value is `15`. memLevel:int How much memory should be allocated for the internal compression state. `1` uses minimum memory and `9` uses maximum memory. Larger values result in better and faster compression at the expense of memory usage. The default value is `8`

public static GzipOptions gzip(int compressionLevel, int windowBits, int memLevel)

Create a new GzipOptions Instance

Parameters

compressionLevel:int: 1 yields the fastest compression and 9 yields the best compression. 0 means no compression. The default compression level is 6.
windowBits:int: The base two logarithm of the size of the history buffer. The value should be in the range 9 to 15 inclusive. Larger values result in better compression at the expense of memory usage. The default value is 15.
memLevel:int: How much memory should be allocated for the internal compression state. 1 uses minimum memory and 9 uses maximum memory. Larger values result in better and faster compression at the expense of memory usage. The default value is 8

snappy	back to summary
public static SnappyOptions snappy() Create a new `SnappyOptions`

zstd	back to summary
public static ZstdOptions zstd() Default implementation of `ZstdOptions` with{compressionLevel(int)} set to `ZstdConstants#DEFAULT_COMPRESSION_LEVEL`,`ZstdConstants#DEFAULT_BLOCK_SIZE`, `ZstdConstants#MAX_BLOCK_SIZE`

zstd back to summary

zstd	back to summary
public static ZstdOptions zstd(int compressionLevel, int blockSize, int maxEncodeSize) Create a new `ZstdOptions` Parameters compressionLevel:int specifies the level of the compression blockSize:int is used to calculate the compressionLevel maxEncodeSize:int specifies the size of the largest compressed object

public static ZstdOptions zstd(int compressionLevel, int blockSize, int maxEncodeSize)

Create a new ZstdOptions

Parameters

compressionLevel:int: specifies the level of the compression
blockSize:int: is used to calculate the compressionLevel
maxEncodeSize:int: specifies the size of the largest compressed object

public final Class StandardCompressionOptions

Constructor Summary

Method Summary

Constructor Detail

Method Detail