Package org.gradle.api.tasks.diagnostics

Class TaskReportTask

  • 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>
    @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.

    • Constructor Detail

      • TaskReportTask

        public TaskReportTask()

    • Method Detail

      • setRenderer

        public void setRenderer​(org.gradle.api.tasks.diagnostics.internal.TaskReportRenderer renderer)

      • setShowDetail

        public void setShowDetail​(boolean detail)
        Sets whether to show "invisible" tasks without a group or dependent tasks. This property can be set via command-line option '--all'.

      • isDetail

        @Console
public boolean isDetail()

      • setDisplayGroup

        public void setDisplayGroup​(java.lang.String group)
        Set a specific task group to be displayed.
        Since:
        5.1

      • getDisplayGroup

        @Console
public java.lang.String getDisplayGroup()
        Returns the task group to be displayed. This property can be set via command-line option '--group'.
        Since:
        5.1

      • setDisplayGroups

        @Incubating
public void setDisplayGroups​(java.util.List<java.lang.String> groups)
        Add a specific task group to be displayed. Same functionality as the '--group' option, but unlike '--group', '--groups' can be chained.
        Since:
        7.5

      • getDisplayGroups

        @Incubating
@Console
public java.util.List<java.lang.String> getDisplayGroups()
        Returns the task groups to be displayed. Task groups can be added via command-line option '--groups'.
        Since:
        7.5

      • getShowTypes

        @Console
public Property<java.lang.Boolean> getShowTypes()
        Whether to show the task types next to their names in the output. This property can be set via command-line option '--types'.
        Since:
        7.4

      • getProjectStateRegistry

        @Inject
protected org.gradle.api.internal.project.ProjectStateRegistry getProjectStateRegistry()
        Injects a ProjectStateRegistry service.
        Since:
        5.0

      • getProjectTaskLister

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