org.gradle.openapi.wrappers.foundation

Class ProjectWrapper

java.lang.Object

org.gradle.openapi.wrappers.foundation.ProjectWrapper

All Implemented Interfaces:

ProjectVersion1

public class ProjectWrapper
extends Object
implements ProjectVersion1

Implementation of ProjectVersion1 meant to help shield external users from internal changes.

Author:

mhunsicker

Constructor Summary

Constructors

Constructor and Description
ProjectWrapper(ProjectView projectView)

Method Summary

Methods

Modifier and Type	Method and Description
static List<ProjectVersion1>	convertProjects(List<ProjectView> projectViewList) Converts the list of ProjectView objects to ProjectVersion1 objects.
boolean	equals(Object obj)
List<TaskVersion1>	getDefaultTasks() Builds a list of default tasks.
List<ProjectVersion1>	getDependantProjects()
File	getFile()
String	getFullProjectName()
String	getName()
ProjectVersion1	getParentProject()
ProjectVersion1	getSubProject(String name)
ProjectVersion1	getSubProjectFromFullPath(String fullProjectName)
List<ProjectVersion1>	getSubProjects()
TaskVersion1	getTask(String name)
TaskVersion1	getTaskFromFullPath(String fullTaskName)
List<TaskVersion1>	getTasks()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ProjectWrapper

public ProjectWrapper(ProjectView projectView)

Method Detail

getName

public String getName()

Specified by:

getName in interface ProjectVersion1

Returns:

the name of this project

getFile

public File getFile()

Specified by:

getFile in interface ProjectVersion1

Returns:

the .gradle file this project is defined in

getTasks

public List<TaskVersion1> getTasks()

Specified by:

getTasks in interface ProjectVersion1

Returns:

the TaskVersion1 objects associated with this project

getSubProjects

public List<ProjectVersion1> getSubProjects()

Specified by:

getSubProjects in interface ProjectVersion1

Returns:

the sub projects of this project

getParentProject

public ProjectVersion1 getParentProject()

Specified by:

getParentProject in interface ProjectVersion1

Returns:

the parent of this project if this is a sub project. Otherwise, null

getDependantProjects

public List<ProjectVersion1> getDependantProjects()

Specified by:

getDependantProjects in interface ProjectVersion1

Returns:

a list of projects that this project depends on.

getSubProject

public ProjectVersion1 getSubProject(String name)

Specified by:

getSubProject in interface ProjectVersion1

getFullProjectName

public String getFullProjectName()

Specified by:

getFullProjectName in interface ProjectVersion1

Returns:

The full project name. This is just the project name if its off of the root. Otherwise, its all of its ancestors separated by colons with this project being last.

getSubProjectFromFullPath

public ProjectVersion1 getSubProjectFromFullPath(String fullProjectName)

Specified by:

getSubProjectFromFullPath in interface ProjectVersion1

getTask

public TaskVersion1 getTask(String name)

Specified by:

getTask in interface ProjectVersion1

getDefaultTasks

public List<TaskVersion1> 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.

Specified by:

getDefaultTasks in interface ProjectVersion1

Returns:

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

getTaskFromFullPath

public TaskVersion1 getTaskFromFullPath(String fullTaskName)

Specified by:

getTaskFromFullPath in interface ProjectVersion1

convertProjects

public static List<ProjectVersion1> convertProjects(List<ProjectView> projectViewList)

Converts the list of ProjectView objects to ProjectVersion1 objects. It just wraps them.

Parameters:

projectViewList - the source projects

Returns:

the projects wrapped in ProjectWrappers.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object