netty5/codec/src/main/java/io/netty/handler/codec/compression/BrotliOptions.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
1.9 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;
import com.aayushatharva.brotli4j.encoder.Encoder;
import io.netty.util.internal.ObjectUtil;
/**
* {@link BrotliOptions} holds {@link Encoder.Parameters} for
* Brotli compression.
*/
public final class BrotliOptions implements CompressionOptions {
private final Encoder.Parameters parameters;
/**
* Default implementation of {@link BrotliOptions} with{@link Encoder.Parameters#setQuality(int)} set to 4
* and {@link Encoder.Parameters#setMode(Encoder.Mode)} set to {@link Encoder.Mode#TEXT}
*/
static final BrotliOptions DEFAULT = new BrotliOptions(
new Encoder.Parameters().setQuality(4).setMode(Encoder.Mode.TEXT)
);
/**
* Create a new {@link BrotliOptions}
*
* @param parameters {@link Encoder.Parameters} Instance
* @throws NullPointerException If {@link Encoder.Parameters} is {@code null}
*/
BrotliOptions(Encoder.Parameters parameters) {
this.parameters = ObjectUtil.checkNotNull(parameters, "Parameters");
if (!Brotli.isAvailable()) {
throw new IllegalStateException("Brotli is not available", Brotli.cause());
}
}
public Encoder.Parameters parameters() {
return parameters;
}
}