Class ConventionReportTask

java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
org.gradle.api.internal.ConventionTask
org.gradle.api.tasks.diagnostics.ConventionReportTask
All Implemented Interfaces:
Comparable<Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.IConventionAware, org.gradle.api.internal.TaskInternal, Named, ExtensionAware, Task, Configurable<Task>
Direct Known Subclasses:
AbstractProjectBasedReportTask, ProjectBasedReportTask, TaskReportTask

@DisableCachingByDefault(because="Abstract super-class, not to be instantiated directly") public abstract class ConventionReportTask extends org.gradle.api.internal.ConventionTask
The base class for all project based report tasks with custom task actions.
Since:
6.9
  • Constructor Details

    • ConventionReportTask

      protected ConventionReportTask()
  • Method Details

    • getProjectReportDirectory

      @Internal public DirectoryProperty getProjectReportDirectory()
      Returns the project report directory.

      The project-report plugin sets the default value for all tasks of this type to buildDir/project.

      Note, that if the project-report plugin is not applied then this property is ignored.

      Returns:
      the directory to store project reports
      Since:
      7.1
    • getRenderer

      @Internal protected abstract org.gradle.api.tasks.diagnostics.internal.ReportRenderer getRenderer()
    • getOutputFile

      @Nullable @Optional @OutputFile public File getOutputFile()
      Returns the file which the report will be written to. When set to null, the report is written to System.out. Defaults to null.
      Returns:
      The output file. May be null.
    • setOutputFile

      public void setOutputFile(@Nullable File outputFile)
      Sets the file which the report will be written to. Set this to null to write the report to System.out.
      Parameters:
      outputFile - The output file. May be null.
    • getProjects

      @Internal public Set<Project> getProjects()
      Returns the set of project to generate this report for. By default, the report is generated for the task's containing project.
      Returns:
      The set of files.
    • setProjects

      public void setProjects(Set<Project> projects)
      Specifies the set of projects to generate this report for.
      Parameters:
      projects - The set of projects. Must not be null.
    • getClientMetaData

      @Inject protected org.gradle.initialization.BuildClientMetaData getClientMetaData()
    • getTextOutputFactory

      @Inject protected org.gradle.internal.logging.text.StyledTextOutputFactory getTextOutputFactory()