de.aaschmid.gradle.plugins.cpd.CpdReports Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gradle-cpd-plugin Show documentation

Gradle plugin to find duplicate code using PMDs copy/paste detection (= CPD)

The newest version!

package de.aaschmid.gradle.plugins.cpd;

import org.gradle.api.Action;
import org.gradle.api.reporting.ReportContainer;
import org.gradle.api.reporting.SingleFileReport;
import org.gradle.api.tasks.Nested;

/**
 * The reporting configuration for the {@link Cpd} task.
 * 
 * One of
 * 

 * csv
 * 
text
 * 
vs
 * 
xml (default)
 * 
 * 
 * The reporting aspects of a {@link Cpd} task can be configured as such:
 * 
 * cpdCheck {
 *     reports {
 *         csv.required = false
 *         text {
 *             required = true
 *             outputLocation = file("${buildDir}/cpd.txt"
 *         }
 *     }
 * }
 * 
 *
 * @see Cpd
 */
public interface CpdReports extends ReportContainer {

    /**
     * @return The CPD (single file) 'CSV' report
     */
    @Nested
    CpdCsvFileReport getCsv();

    /**
     * @return The CPD (single file) 'text' report
     */
    @Nested
    CpdTextFileReport getText();

    /**
     * @return The CPD (single file) 'vs' report
     */
    @Nested
    SingleFileReport getVs();

    /**
     * @return The CPD (single file) 'XML' report
     */
    @Nested
    CpdXmlFileReport getXml();

    /**
     * Configures the csv report.
     *
     * @param action The Configuration closure/action.
     */
    void csv(Action action);

    /**
     * Configures the text report.
     *
     * @param action The Configuration closure/action.
     */
    void text(Action action);

    /**
     * Configures the vs report.
     *
     * @param action The Configuration closure/action.
     */
    void vs(Action action);

    /**
     * Configures the xml report.
     *
     * @param action The Configuration closure/action.
     */
    void xml(Action action);
}