org.netbeans.modules.gradle.api

Class GradleTask

java.lang.Object

org.netbeans.modules.gradle.api.GradleTask

All Implemented Interfaces:

Serializable

public final class GradleTask
extends Object
implements Serializable

Represent a task in a Gradle project.

Since:

1.0

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
String	getDescription()
String	getGroup()
String	getName()
String	getPath()
String	getProjectPath() Returns path of the task's declaring project.
boolean	isExternal() Determines if the task is external, from another project.
boolean	isPrivate() Tasks without groups are considered private in Gradle.
boolean	matches(String abbrev) Returns true if the given CamelCase abbreviation matches this task name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getPath

public String getPath()

getGroup

public String getGroup()

getName

public String getName()

isExternal

public boolean isExternal()

Determines if the task is external, from another project. External tasks do not report all properties, such as group or description - the task must be fetched from its project. Such tasks are never served from the project itself, i.e. GradleBaseProject.getTasks(), but may represent project task's dependency.

To get the task's details, lookup its project (identified by GradleTask.getProjectPath(), and use GradleBaseProject.getTaskByName(java.lang.String) to get the external task's declaration info.

Returns:

true, if the task is external, from another project.

Since:

2.29

getProjectPath

public String getProjectPath()

Returns path of the task's declaring project. Returns path, except the last component, which is the task name.

Returns:

project path.

Since:

2.29

getDescription

public String getDescription()

isPrivate

public boolean isPrivate()

Tasks without groups are considered private in Gradle.

Returns:

true if this task is private.

matches

public boolean matches(String abbrev)

Returns true if the given CamelCase abbreviation matches this task name.

Parameters:

abbrev - the camel case abbreviation

Returns:

true if the abbreviation can be matched to this task name.