Package org.gradle.api.tasks.diagnostics

Class TaskReportTask

java.lang.Object

org.gradle.api.internal.AbstractTask

org.gradle.api.DefaultTask

org.gradle.api.internal.ConventionTask

org.gradle.api.tasks.diagnostics.ConventionReportTask

org.gradle.api.tasks.diagnostics.TaskReportTask

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>

@DisableCachingByDefault(because="Not worth caching")
public abstract class TaskReportTask
extends ConventionReportTask

Displays a list of tasks in the project. An instance of this type is used when you execute the tasks task from the command-line.

By default, this report shows only those tasks which have been assigned to a task group, so-called visible tasks. Tasks which have not been assigned to a task group, so-called hidden tasks, can be included in the report by enabling the command line option --all.

Nested Class Summary

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

Named.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

Constructor	Description
TaskReportTask()

Method Summary

Modifier and Type	Method	Description
(package private) void	generate()
abstract Property<String>	getDisplayGroup()	Returns the task group to be displayed.
abstract ListProperty<String>	getDisplayGroups()	Returns the task groups to be displayed.
Property<Boolean>	getIsShowDetail()
protected abstract org.gradle.api.internal.project.ProjectTaskLister	getProjectTaskLister()
abstract Property<org.gradle.api.tasks.diagnostics.internal.TaskReportRenderer>	getRenderer()
abstract Property<Boolean>	getShowDetail()	Sets whether to show "invisible" tasks without a group or dependent tasks.
abstract Property<Boolean>	getShowProvenance()	Whether to show where tasks were registered next to their names in the output.
abstract Property<Boolean>	getShowTypes()	Whether to show the task types next to their names in the output.

Methods inherited from class org.gradle.api.tasks.diagnostics.ConventionReportTask

getClientMetaData, getObjectFactory, getOutputFile, getProjectReportDirectory, getProjects, getTextOutputFactory, logClickableOutputFileUrl, reportGenerator

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, doNotTrackStateIf, getAsDynamicObject, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonsNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, restoreOnlyIf, restoreTaskActions, 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, notCompatibleWithConfigurationCache

Constructor Details

TaskReportTask

public TaskReportTask()

Method Details

getRenderer

public abstract Property<org.gradle.api.tasks.diagnostics.internal.TaskReportRenderer> getRenderer()

Specified by:

getRenderer in class ConventionReportTask

getShowDetail

@Input
public abstract Property<Boolean> getShowDetail()

Sets whether to show "invisible" tasks without a group or dependent tasks.

Since:

9.0

getIsShowDetail

@Internal
public Property<Boolean> getIsShowDetail()

getDisplayGroup

@Console
public abstract Property<String> getDisplayGroup()

Returns the task group to be displayed.

Since:

5.1

getDisplayGroups

@Console
public abstract ListProperty<String> getDisplayGroups()

Returns the task groups to be displayed.

Since:

7.5

getShowTypes

@Console
public abstract Property<Boolean> getShowTypes()

Whether to show the task types next to their names in the output.

Since:

7.4

getShowProvenance

@Console
@Incubating
public abstract Property<Boolean> getShowProvenance()

Whether to show where tasks were registered next to their names in the output. This property can be set via command-line option '--provenance'.

Since:

9.5.0

generate

void generate()

getProjectTaskLister

@Inject
protected abstract org.gradle.api.internal.project.ProjectTaskLister getProjectTaskLister()