/*
 * Copyright 2005-2016 Sixth and Red River Software, Bas Leijdekkers
 *
 *  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.sixrr.metrics;

import com.intellij.openapi.extensions.ExtensionPointName;
import org.jetbrains.annotations.NotNull;

import java.util.List;

/**
 * To add metrics to IntelliJ IDEA, you first create the Metric classes for them, and then bind them into IDEA using a
 * MetricsProvider component.  Create an implementation of MetricsProvider which lists the metrics you wish to add.
 * Additionally, you can specify a list of pre-built metrics profiles, which may make it easier for new users to use your
 * metrics.
 */
public interface MetricProvider {

    ExtensionPointName<MetricProvider> EXTENSION_POINT_NAME =
            ExtensionPointName.create("MetricsReloaded.metricProvider");

    /**
     * Returns the list of metrics provided by this provider.
     * @return the metrics for this provider
     */
    @NotNull
    List<Metric> getMetrics();

    /**
     * Returns the list of prebuilt metrics profiles provided by this provider.
     * @return the prebuilt metrics profiles for this provider.
     */
    @NotNull
    List<PrebuiltMetricProfile> getPrebuiltProfiles();
}