netty5/codec/src/main/java/io/netty/handler/codec/compression/GzipOptions.java
Aayush Atharva fef761d03e
Introduce BrotliEncoder (#11256)
Motivation:
Currently, Netty only has BrotliDecoder which can decode Brotli encoded data. However, BrotliEncoder is missing which will encode normal data to Brotli encoded data.

Modification:
Added BrotliEncoder and CompressionOption

Result:
Fixes #6899.

Co-authored-by: Norman Maurer <norman_maurer@apple.com>
2021-07-08 11:51:27 +02:00

55 lines
2.4 KiB
Java

/*
* Copyright 2021 The Netty Project
*
* The Netty Project licenses this file to you under the Apache License,
* version 2.0 (the "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at:
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations
* under the License.
*/
package io.netty.handler.codec.compression;
/**
* {@link GzipOptions} holds {@link #compressionLevel()},
* {@link #memLevel()} and {@link #windowBits()} for Gzip compression.
* This class is an extension of {@link DeflateOptions}
*/
public final class GzipOptions extends DeflateOptions {
/**
* Default implementation of {@link GzipOptions} with
* {@link #compressionLevel()} set to 6, {@link #windowBits()} set to 15
* and {@link #memLevel()} set to 8.
*/
static final GzipOptions DEFAULT = new GzipOptions(
6, 15, 8
);
/**
* Create a new {@link GzipOptions} Instance
*
* @param compressionLevel {@code 1} yields the fastest compression and {@code 9} yields the
* best compression. {@code 0} means no compression. The default
* compression level is {@code 6}.
*
* @param windowBits The base two logarithm of the size of the history buffer. The
* value should be in the range {@code 9} to {@code 15} inclusive.
* Larger values result in better compression at the expense of
* memory usage. The default value is {@code 15}.
*
* @param memLevel How much memory should be allocated for the internal compression
* state. {@code 1} uses minimum memory and {@code 9} uses maximum
* memory. Larger values result in better and faster compression
* at the expense of memory usage. The default value is {@code 8}
*/
GzipOptions(int compressionLevel, int windowBits, int memLevel) {
super(compressionLevel, windowBits, memLevel);
}
}