io.qameta.allure.Reader Maven / Gradle / Ivy

Go to download
/*
 *  Copyright 2019 Qameta Software OÜ
 *
 *  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 io.qameta.allure;

import io.qameta.allure.core.Configuration;
import io.qameta.allure.core.ResultsVisitor;

import java.nio.file.Path;

/**
 * Reader extension. Can read some data from results folder add store into storage using
 * {@link ResultsVisitor}.
 *
 * @since 2.0
 */
@FunctionalInterface
public interface Reader extends Extension {

    /**
     * Process results directory.
     *
     * @param configuration the report configuration.
     * @param visitor       the visitor to store data into results storage.
     * @param directory     the results directory to process.
     */
    void readResults(Configuration configuration, ResultsVisitor visitor, Path directory);

}