QLogConfiguration.java — netty Source File

Source Code

/*
 * 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.quic;

import java.util.Objects;

/**
 * Configuration used for setup
 * <a href="https://quiclog.github.io/internet-drafts/draft-marx-qlog-main-schema.html">qlog</a>.
 */
public final class QLogConfiguration {

    private final String path;
    private final String logTitle;
    private final String logDescription;

    /**
     * Create a new configuration.
     *
     * @param path              the path to the log file to use. This file must not exist yet. If the path is a
     *                          directory the filename will be generated
     * @param logTitle          the title to use when logging.
     * @param logDescription    the description to use when logging.
     */
    public QLogConfiguration(String path, String logTitle, String logDescription) {
        this.path = Objects.requireNonNull(path, "path");
        this.logTitle = Objects.requireNonNull(logTitle, "logTitle");
        this.logDescription = Objects.requireNonNull(logDescription, "logDescription");
    }

    /**
     * Return the path to the log file.
     *
     * @return the path.
     */
    public String path() {
        return path;
    }

    /**
     * Return the title.
     *
     * @return the title.
     */
    public String logTitle() {
        return logTitle;
    }

    /**
     * Return the description.
     *
     * @return the description.
     */
    public String logDescription() {
        return logDescription;
    }
}