org.gradle.api.reporting.Reporting Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gradle-api Show documentation
Gradle 6.9.1 API redistribution.
There is a newer version: 8.11.1
/*
 * Copyright 2009 the original author or authors.
 *
 * 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 org.gradle.api.reporting;

import groovy.lang.Closure;
import groovy.lang.DelegatesTo;
import org.gradle.api.Action;

/**
 * An object that provides reporting options.
 * 
 * Tasks that produce reports as part of their execution expose configuration options of those reports via these methods.
 * The {@code Reporting} interface is parameterized, where the parameter denotes the specific type of reporting container
 * that is exposed. The specific type of the reporting container denotes the different types of reports available.
 * 

 * For example, given a task such as:
 * 
 *  * class MyTask implements Reporting<MyReportContainer> {
 *     // implementation
 * }
 *
 * interface MyReportContainer extends ReportContainer<Report> {
 *     Report getHtml();
 *     Report getCsv();
 * }
 * 
 * 
 * The reporting aspects of such a task can be configured as such:
 * 
 *  * task my(type: MyTask) {
 *     reports {
 *         html.enabled = true
 *         csv.enabled = false
 *     }
 * }
 * 
 * 
 * See the documentation for the specific {@code ReportContainer} type for the task for information on report types and options.
 * 
 *
 * @param  The base type of the report container
 */
public interface Reporting {

    /**
     * A {@link ReportContainer} instance.
     * 
     * Implementors specify a specific implementation of {@link ReportContainer} that describes the types of reports that
     * are available.
     *
     * @return The report container
     */
    T getReports();

    /**
     * Allow configuration of the report container by closure.
     *
     * 
     * reports {
     *   html {
     *     enabled false
     *   }
     *   xml.destination "build/reports/myReport.xml"
     * }
     * 
     *
     * @param closure The configuration
     * @return The report container
     */
    T reports(@DelegatesTo(type="T", strategy = Closure.DELEGATE_FIRST) Closure closure);

    /**
     * Allow configuration of the report container by closure.
     *
     *      * reports {
     *   html {
     *     enabled false
     *   }
     *   xml.destination "build/reports/myReport.xml"
     * }
     * 
     * @param configureAction The configuration
     * @return The report container
     */
    T reports(Action configureAction);
}