com.swirlds.common.metrics.PlatformMetricConfig Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of swirlds-common Show documentation

Swirlds is a software platform designed to build fully-distributed applications that harness the power of the cloud without servers. Now you can develop applications with fairness in decision making, speed, trust and reliability, at a fraction of the cost of traditional server-based platforms.

There is a newer version: 0.56.6

Show newest version

/*
 * Copyright (C) 2023-2024 Hedera Hashgraph, LLC
 *
 * Licensed 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
 *
 *      http://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 com.swirlds.common.metrics;

import com.swirlds.metrics.api.Metric;
import com.swirlds.metrics.api.MetricConfig;
import com.swirlds.metrics.api.MetricsFactory;
import edu.umd.cs.findbugs.annotations.NonNull;

/**
 * An extension of the {@link MetricConfig} that adds the ability to create a {@link Metric} from a
 * {@link PlatformMetricsFactory}.
 *
 * @param  the type of the {@link Metric} that is created
 * @param  the type of the {@link MetricConfig} that is used to create the {@link Metric}
 */
public abstract class PlatformMetricConfig> extends MetricConfig {

    /**
     * Constructs a new {@link PlatformMetricConfig} with the given parameters.
     *
     * @param category    the category of the {@link Metric}
     * @param name        the name of the {@link Metric}
     * @param description the description of the {@link Metric}
     * @param unit        the unit of the {@link Metric}
     * @param format      the format of the {@link Metric}
     */
    protected PlatformMetricConfig(
            @NonNull final String category,
            @NonNull final String name,
            @NonNull final String description,
            @NonNull final String unit,
            @NonNull final String format) {
        super(category, name, description, unit, format);
    }

    /**
     * Constructs a new {@link PlatformMetricConfig} with the given parameters.
     *
     * @param category      the category of the {@link Metric}
     * @param name          the name of the {@link Metric}
     * @param defaultFormat the default format of the {@link Metric}
     */
    protected PlatformMetricConfig(
            @NonNull final String category, @NonNull final String name, @NonNull final String defaultFormat) {
        super(category, name, defaultFormat);
    }

    /**
     * Constructs a new {@link Metric} with the given {@link PlatformMetricsFactory}.
     *
     * @param factory the {@link PlatformMetricsFactory} used to create the {@link Metric}
     * @return the created {@link Metric}
     */
    public abstract T create(@NonNull final PlatformMetricsFactory factory);

    @NonNull
    @Override
    public final T create(@NonNull MetricsFactory factory) {
        if (factory instanceof PlatformMetricsFactory) {
            return create((PlatformMetricsFactory) factory);
        }
        throw new IllegalStateException("MetricsFactory must be a PlatformMetricsFactory");
    }
}