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:

java.lang.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 Summary

Nested classes/interfaces inherited from interface org.gradle.api.Task

Task.Namer

Field Summary

Fields inherited from interface org.gradle.api.Task

TASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ConventionReportTask()

Method Summary

Modifier and Type	Method	Description
protected org.gradle.initialization.BuildClientMetaData	getClientMetaData()
java.io.File	getOutputFile()	Returns the file which the report will be written to.
DirectoryProperty	getProjectReportDirectory()	Returns the project report directory.
java.util.Set<Project>	getProjects()	Returns the set of project to generate this report for.
protected abstract org.gradle.api.tasks.diagnostics.internal.ReportRenderer	getRenderer()
protected org.gradle.internal.logging.text.StyledTextOutputFactory	getTextOutputFactory()
void	setOutputFile(java.io.File outputFile)	Sets the file which the report will be written to.
void	setProjects(java.util.Set<Project> projects)	Specifies the set of projects to generate this report for.

Methods inherited from class org.gradle.api.internal.ConventionTask

conventionMapping, conventionMapping, getConventionMapping

Methods inherited from class org.gradle.api.DefaultTask

compareTo, 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, usesService

Methods inherited from class org.gradle.api.internal.AbstractTask

acceptServiceReferences, appendParallelSafeAction, doNotTrackState, getAsDynamicObject, getConvention, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, setImpliesSubProjects

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.gradle.api.Task

doNotTrackState, getConvention, notCompatibleWithConfigurationCache

Constructor Detail

ConventionReportTask

protected ConventionReportTask()

Method Detail

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 java.io.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
                          java.io.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 java.util.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(java.util.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()