java.lang.Comparable<Task>
, org.gradle.api.internal.DynamicObjectAware
, org.gradle.api.internal.IConventionAware
, org.gradle.api.internal.TaskInternal
, ExtensionAware
, Task
, Configurable<Task>
AbstractProjectBasedReportTask
, ProjectBasedReportTask
, TaskReportTask
@DisableCachingByDefault(because="Abstract super-class, not to be instantiated directly") public abstract class ConventionReportTask extends org.gradle.api.internal.ConventionTask
Task.Namer
TASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE
Modifier | Constructor | Description |
---|---|---|
protected |
ConventionReportTask() |
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.
|
conventionMapping, conventionMapping, getConventionMapping
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
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
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
doNotTrackState, getConvention, notCompatibleWithConfigurationCache
@Internal public DirectoryProperty getProjectReportDirectory()
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.
@Internal protected abstract org.gradle.api.tasks.diagnostics.internal.ReportRenderer getRenderer()
@Nullable @Optional @OutputFile public java.io.File getOutputFile()
null
, the report is written to System.out
.
Defaults to null
.public void setOutputFile(@Nullable java.io.File outputFile)
null
to write the report to System.out
.outputFile
- The output file. May be null.@Internal public java.util.Set<Project> getProjects()
public void setProjects(java.util.Set<Project> projects)
projects
- The set of projects. Must not be null.@Inject protected org.gradle.initialization.BuildClientMetaData getClientMetaData()
@Inject protected org.gradle.internal.logging.text.StyledTextOutputFactory getTextOutputFactory()