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

import com.sixrr.metrics.Metric;
import org.jetbrains.annotations.Nullable;

import java.io.File;
import java.io.IOException;
import java.util.List;

public interface MetricsProfile extends Cloneable {

    void addMetricInstance(MetricInstance metricInstance);

    MetricsProfile clone() throws CloneNotSupportedException;

    void copyFrom(List<MetricInstance> metrics);

    void setName(String newProfileName);

    String getName();

    List<MetricInstance> getMetricInstances();

    @Nullable MetricInstance getMetricInstance(Metric metric);

    @Nullable MetricInstance getMetricInstance(String metricID);

    void writeToFile(File profileFile) throws IOException;

    MetricDisplaySpecification getDisplaySpecification();

    void setBuiltIn(boolean builtIn);

    boolean isBuiltIn();
}