org.gradle.tooling.model

Interface Task

All Superinterfaces:

Launchable

All Known Subinterfaces:

GradleTask

public interface Task
extends Launchable

Represents a task which is executable by Gradle.

Note: Task extends Launchable since 1.12.

Since:

1.0-milestone-3

Method Summary

Methods

Modifier and Type	Method and Description
String	getDescription() Returns the description of this task, or null if it has no description.
String	getName() Returns the name of this task.
String	getPath() Returns the path of this task.
Element	getProject() Deprecated. Do not use this method. It is assumed that the caller already has a reference to owning project.

Methods inherited from interface org.gradle.tooling.model.Launchable

getDisplayName

Method Detail

getPath

String getPath()

Returns the path of this task. This is a fully qualified unique name for this task.

Returns:

The path of this task.

Since:

1.0-milestone-3

getName

String getName()

Returns the name of this task. Note that the name is not necessarily a unique identifier for the task.

Returns:

The name of this task.

Since:

1.0-milestone-3

getDescription

@Nullable
String getDescription()

Returns the description of this task, or null if it has no description.

Specified by:

getDescription in interface Launchable

Returns:

The description of this task, or null if it has no description.

Since:

1.0-milestone-3

getProject

@Deprecated
Element getProject()

Deprecated. Do not use this method. It is assumed that the caller already has a reference to owning project.

Returns the element which this task belongs to.

Returns:

The element which this task belongs to. Since 1.12 some implementations can return null.

Throws:

UnsupportedMethodException - thrown from implementation like BuildInvocations.

Since:

1.0-milestone-3