/*
 * Copyright 2020 LINE Corporation
 *
 * LINE Corporation 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 com.linecorp.decaton.benchmark;

import java.nio.file.Path;
import java.util.Optional;

/**
 * Profile the running JVM while executing benchmark.
 */
public interface Profiling {
    Profiling NOOP = new Profiling() {
        @Override
        public void start() {
            // noop
        }

        @Override
        public Optional<Path> stop() {
            return Optional.empty();
        }
    };

    /**
     * Start profiling.
     */
    void start();

    /**
     * Stop profiling.
     * @return the path storing profiling output.
     */
    Optional<Path> stop();
}
