Home / File/ BrotliMode.java — netty Source File

BrotliMode.java — netty Source File

Architecture documentation for BrotliMode.java, a java file in the netty codebase.

Entity Profile

Relationship Graph

Source Code

/*
 * Copyright 2024 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 static com.aayushatharva.brotli4j.encoder.Encoder.Mode;

/**
 * Provides a way to specify the Brotli compression mode.
 */
public enum BrotliMode {

    /**
     * The compressor does not make any assumptions about the input data's properties,
     * making it suitable for a wide range of data types.
     * default mode.
     */
    GENERIC,

    /**
     * Optimized for UTF-8 formatted text input.
     */
    TEXT,

    /**
     * Designed specifically for font data compression, as used in WOFF 2.0.
     */
    FONT;

    /**
     * Convert to Brotli {@link Encoder.Mode}.
     *
     * @return a new {@link Encoder.Mode}
     */
    Mode adapt() {
        switch (this) {
            case GENERIC:
                return Mode.GENERIC;
            case TEXT:
                return Mode.TEXT;
            case FONT:
                return Mode.FONT;
            default:
                throw new IllegalStateException("Unsupported enum value: " + this);
        }
    }
}

Types

Frequently Asked Questions

What does BrotliMode.java do?
BrotliMode.java is a source file in the netty codebase, written in java.
Where is BrotliMode.java in the architecture?
BrotliMode.java is located at codec-compression/src/main/java/io/netty/handler/codec/compression/BrotliMode.java (directory: codec-compression/src/main/java/io/netty/handler/codec/compression).

Analyze Your Own Codebase

Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.

Try Supermodel Free