Package org.gradle.api.tasks.diagnostics
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
- 
Nested Class SummaryNested classes/interfaces inherited from interface org.gradle.api.TaskTask.Namer
- 
Field SummaryFields inherited from interface org.gradle.api.TaskTASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionprotected org.gradle.initialization.BuildClientMetaDataReturns the file which the report will be written to.Returns the project report directory.Returns the set of project to generate this report for.protected abstract org.gradle.api.tasks.diagnostics.internal.ReportRendererprotected org.gradle.internal.logging.text.StyledTextOutputFactoryvoidsetOutputFile(File outputFile) Sets the file which the report will be written to.voidsetProjects(Set<Project> projects) Specifies the set of projects to generate this report for.Methods inherited from class org.gradle.api.internal.ConventionTaskconventionMapping, conventionMapping, getConventionMappingMethods inherited from class org.gradle.api.DefaultTaskcompareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, onlyIf, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesServiceMethods inherited from class org.gradle.api.internal.AbstractTaskacceptServiceReferences, appendParallelSafeAction, doNotTrackState, getAsDynamicObject, getConvention, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, setImpliesSubProjectsMethods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.gradle.api.TaskdoNotTrackState, getConvention, notCompatibleWithConfigurationCache
- 
Constructor Details- 
ConventionReportTaskprotected ConventionReportTask()
 
- 
- 
Method Details- 
getProjectReportDirectoryReturns the project report directory.The project-reportplugin sets the default value for all tasks of this type tobuildDir/project.Note, that if the project-reportplugin is not applied then this property is ignored.- Returns:
- the directory to store project reports
- Since:
- 7.1
 
- 
getRenderer
- 
getOutputFileReturns the file which the report will be written to. When set tonull, the report is written toSystem.out. Defaults tonull.- Returns:
- The output file. May be null.
 
- 
setOutputFileSets the file which the report will be written to. Set this tonullto write the report toSystem.out.- Parameters:
- outputFile- The output file. May be null.
 
- 
getProjectsReturns 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.
 
- 
setProjectsSpecifies 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()
 
-