org.gradle.foundation

Class TaskView

java.lang.Object

org.gradle.foundation.TaskView

All Implemented Interfaces:

Serializable, Comparable<TaskView>

public class TaskView
extends Object
implements Comparable<TaskView>, Serializable

Analog to gradle's Task but more light-weight and better suited for using the gradle API from an IDE plugin. It is also easily serializable for passing across a socket. A task is something you can execute and is part of a project. This is immutable and ultimately comes from gradle files.

Author:

mhunsicker

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(TaskView otherTask)
String	getDescription()
String	getFullTaskName() This generates this task's full name.
String	getName()
ProjectView	getProject()
boolean	hasDescription()
boolean	isDefault() returns whether or not this is a default task for its parent project.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getProject

public ProjectView getProject()

getName

public String getName()

getDescription

public String getDescription()

hasDescription

public boolean hasDescription()

isDefault

public boolean isDefault()

returns whether or not this is a default task for its parent project. These are defined by specifying defaultTasks 'task name' in the gradle file. There can be multiple default tasks.

Returns:

true if its a default task, false if not.

compareTo

public int compareTo(TaskView otherTask)

Specified by:

compareTo in interface Comparable<TaskView>

toString

public String toString()

Overrides:

toString in class Object

getFullTaskName

public String getFullTaskName()

This generates this task's full name. This is a colon-separated string of this task and its parent projects. Example: root_project:sub_project:sub_sub_project:task.