001/*
002 * Copyright © 2025 CUI-OpenSource-Software (info@cuioss.de)
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package de.cuioss.benchmarking.common.converter;
017
018import de.cuioss.benchmarking.common.model.BenchmarkData;
019
020import java.io.IOException;
021import java.nio.file.Path;
022
023/**
024 * Interface for converting benchmark-specific formats to the central BenchmarkData model.
025 * Implementations should handle specific benchmark tools (JMH, WRK, etc.)
026 */
027public interface BenchmarkConverter {
028
029    /**
030     * Converts benchmark results from a specific format to BenchmarkData
031     *
032     * @param sourcePath Path to the source benchmark results
033     * @return Converted BenchmarkData
034     * @throws IOException if conversion fails
035     */
036    BenchmarkData convert(Path sourcePath) throws IOException;
037
038    /**
039     * Checks if this converter can handle the given file
040     *
041     * @param sourcePath Path to check
042     * @return true if this converter can process the file
043     */
044    boolean canConvert(Path sourcePath);
045}