gradle/org.gradle.api.tasks.diagnostics/TaskReportTask

TaskReportTask

@DisableCachingByDefault(because = "Not worth caching")

abstract class TaskReportTask : ConventionReportTask(source)

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.

Constructors

constructor()

Properties

conventionMapping

open val conventionMapping: ConventionMapping

open var description: String

open var enabled: Boolean

val ExtensionAware.extra: ExtraPropertiesExtension

The extra properties extension in this object's extension container.

open var group: String

impliesSubProjects

open var impliesSubProjects: Boolean

open var outputFile: File

val showTypes: Property<Boolean>

val state: TaskStateInternal

val TASK_ACTION: String = "action"

TASK_CONSTRUCTOR_ARGS

val TASK_CONSTRUCTOR_ARGS: String = "constructorArgs"

TASK_DEPENDS_ON

val TASK_DEPENDS_ON: String = "dependsOn"

TASK_DESCRIPTION

val TASK_DESCRIPTION: String = "description"

val TASK_GROUP: String = "group"

val TASK_NAME: String = "name"

val TASK_OVERWRITE: String = "overwrite"

val TASK_TYPE: String = "type"

val timeout: Property<Duration>

Functions

acceptServiceReferences

open fun acceptServiceReferences(serviceReferences: Set<ServiceReferenceSpec>)

appendParallelSafeAction

open fun appendParallelSafeAction(action: Action<in Task>)

open fun compareTo(otherTask: Task): Int

open fun configure(closure: Closure): Task

abstract fun configure(cl: Closure): T

inline fun <T : Any> ExtensionAware.configure(noinline configuration: T.() -> Unit)

Executes the given configuration block against the extension of the specified type.

conventionMapping

open fun conventionMapping(property: String, mapping: Callable<out Any>): Task

open fun dependsOn(paths: Array<Any>): Task

open fun doFirst(action: Action<in Task>): Task

open fun doLast(action: Action<in Task>): Task

doNotTrackState

open fun doNotTrackState(reasonNotToTrackState: String)

open fun finalizedBy(paths: Array<Any>): Task

open fun getActions(): List<Action<in Task>>

open fun getAnt(): AntBuilder

getAsDynamicObject

open fun getAsDynamicObject(): DynamicObject

open fun getConvention(): Convention

open fun getDependsOn(): Set<Any>

getDestroyables

open fun getDestroyables(): TaskDestroyables

open fun getDidWork(): Boolean

getDisplayGroup

open fun getDisplayGroup(): String

Returns the task group to be displayed.

getDisplayGroups

open fun getDisplayGroups(): List<String>

Returns the task groups to be displayed.

open fun getExtensions(): ExtensionContainer

open fun getFinalizedBy(): TaskDependency

getIdentityPath

open fun getIdentityPath(): Path

open fun getInputs(): TaskInputsInternal

abstract fun getInputs(): TaskInputs

getLifecycleDependencies

open fun getLifecycleDependencies(): TaskDependencyInternal

abstract fun getLifecycleDependencies(): TaskDependency

open fun getLocalState(): TaskLocalState

open fun getLogger(): Logger

open fun getLogging(): LoggingManager

getMustRunAfter

open fun getMustRunAfter(): TaskDependency

open fun getName(): String

open fun getOnlyIf(): Spec<in TaskInternal>

open fun getOutputs(): TaskOutputsInternal

abstract fun getOutputs(): TaskOutputs

open fun getPath(): String

open fun getProject(): Project

getProjectReportDirectory

open fun getProjectReportDirectory(): DirectoryProperty

open fun getProjects(): Set<Project>

getReasonNotToTrackState

open fun getReasonNotToTrackState(): Optional<String>

getReasonTaskIsIncompatibleWithConfigurationCache

open fun getReasonTaskIsIncompatibleWithConfigurationCache(): Optional<String>

open fun getRenderer(): ReportRenderer

getRequiredServices

open fun getRequiredServices(): TaskRequiredServices

getSharedResources

open fun getSharedResources(): List<ResourceLock>

abstract fun getSharedResources(): List<out ResourceLock>

getShouldRunAfter

open fun getShouldRunAfter(): TaskDependency

getStandardOutputCapture

open fun getStandardOutputCapture(): StandardOutputCapture

abstract fun getState(): TaskState

open fun getTaskActions(): List<InputChangesAwareTaskAction>

getTaskDependencies

open fun getTaskDependencies(): TaskDependencyInternal

abstract fun getTaskDependencies(): TaskDependency

getTaskIdentity

open fun getTaskIdentity(): TaskIdentity<out Any>

getTemporaryDir

open fun getTemporaryDir(): File

getTemporaryDirFactory

open fun getTemporaryDirFactory(): Factory<File>

open fun hasProperty(propertyName: String): Boolean

open fun hasTaskActions(): Boolean

injectIntoNewInstance

open fun <T : Task?> injectIntoNewInstance(project: ProjectInternal, identity: TaskIdentity<T>, factory: Callable<T>): T

isCompatibleWithConfigurationCache

open fun isCompatibleWithConfigurationCache(): Boolean

open fun isDetail(): Boolean

open fun isEnabled(): Boolean

isHasCustomActions

open fun isHasCustomActions(): Boolean

open fun mustRunAfter(paths: Array<Any>): Task

notCompatibleWithConfigurationCache

open fun notCompatibleWithConfigurationCache(reason: String)

open fun onlyIf(spec: Spec<in Task>)

prependParallelSafeAction

open fun prependParallelSafeAction(action: Action<in Task>)

open fun property(propertyName: String): Any

open fun setActions(replacements: List<Action<in Task>>)

open fun setDependsOn(dependsOn: Iterable<out Any>)

open fun setDidWork(didWork: Boolean)

setDisplayGroup

open fun setDisplayGroup(group: String)

Set a specific task group to be displayed.

setDisplayGroups

open fun setDisplayGroups(groups: List<String>)

Add a specific task group to be displayed.

open fun setFinalizedBy(finalizedByTasks: Iterable<out Any>)

setMustRunAfter

open fun setMustRunAfter(mustRunAfterTasks: Iterable<out Any>)

open fun setOnlyIf(spec: Spec<in Task>)

open fun setProjects(projects: Set<Project>)

open fun setProperty(name: String, value: Any)

open fun setRenderer(renderer: TaskReportRenderer)

setShouldRunAfter

open fun setShouldRunAfter(shouldRunAfterTasks: Iterable<out Any>)

open fun setShowDetail(detail: Boolean)

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

open fun shouldRunAfter(paths: Array<Any>): TaskDependency

inline fun <T : Any> ExtensionAware.the(): T

Returns the extension of the specified type.

fun <T : Any> ExtensionAware.the(extensionType: KClass<T>): T

Returns the extension of the specified extensionType.

open fun usesService(service: Provider<out BuildService<out Any>>)