org.gradle.foundation

Class ProjectView

java.lang.Object

org.gradle.foundation.ProjectView

All Implemented Interfaces:

Serializable, Comparable<ProjectView>

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

Analog to gradle's Project but more light-weight and is better suited for using the gradle API from an IDE plugin. It is also easily serializable for passing across a socket. A project is a collection of source files that have tasks associated with them. The tasks build the project. Projects can contain other projects. 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(ProjectView otherProject)
File	getBuildFile()
List<TaskView>	getDefaultTasks() Builds a list of default tasks.
List<ProjectView>	getDependsOnProjects()
String	getDescription()
String	getFullProjectName() This generates this project's full name.
String	getName()
ProjectView	getParentProject()
ProjectView	getSubProject(String name)
ProjectView	getSubProjectFromFullPath(String fullProjectName)
List<ProjectView>	getSubProjects()
TaskView	getTask(String name)
TaskView	getTaskFromFullPath(String fullTaskName) This gets the task based on the given full path.
List<TaskView>	getTasks()
void	sortSubProjectsAndTasks()
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getName

public String getName()

getBuildFile

public File getBuildFile()

getDescription

public String getDescription()

toString

public String toString()

Overrides:

toString in class Object

getParentProject

public ProjectView getParentProject()

compareTo

public int compareTo(ProjectView otherProject)

Specified by:

compareTo in interface Comparable<ProjectView>

getDependsOnProjects

public List<ProjectView> getDependsOnProjects()

getTasks

public List<TaskView> getTasks()

getSubProjects

public List<ProjectView> getSubProjects()

sortSubProjectsAndTasks

public void sortSubProjectsAndTasks()

getSubProject

public ProjectView getSubProject(String name)

getTask

public TaskView getTask(String name)

getSubProjectFromFullPath

public ProjectView getSubProjectFromFullPath(String fullProjectName)

getTaskFromFullPath

public TaskView getTaskFromFullPath(String fullTaskName)

This gets the task based on the given full path. This recursively calls this same function with sub projects until it finds the task or no matches are found.

Parameters:

fullTaskName - the full task name (root_project:sub_project:sub_sub_project:task.).

Returns:

the task or null if not found.

getFullProjectName

public String getFullProjectName()

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

getDefaultTasks

public List<TaskView> getDefaultTasks()

Builds a list of default tasks. These are defined by specifying defaultTasks 'task name' in the gradle file. There can be multiple default tasks. This only returns default tasks directly for this project and does not return them for subprojects.

Returns:

a list of default tasks or an empty list if none exist