org.gradle.openapi.external.foundation

Interface GradleInterfaceVersion2

All Superinterfaces:

GradleInterfaceVersion1

All Known Implementing Classes:

GradleInterfaceWrapperVersion2

public interface GradleInterfaceVersion2
extends GradleInterfaceVersion1

This is an abstraction from Gradle that allows you to retrieve projects and views from it. This is a mirror of GradlePluginLord inside Gradle, but this is meant to aid backward and forward compatibility by shielding you from direct changes within gradle.

Author:

mhunsicker

Method Summary

Methods

Modifier and Type	Method and Description
void	addRequestObserver(RequestObserverVersion1 observer) Adds an observer that is notified when Gradle commands are executed and completed.
RequestVersion1	executeCommand2(String commandLineArguments, String displayName) Call this to execute the given gradle command.
RequestVersion1	executeFavorites(List<FavoriteTaskVersion1> favorites) Executes several favorites commands at once as a single command.
String	getVersion()
RequestVersion1	refreshTaskTree2() This refreshes the projects and task list.
RequestVersion1	refreshTaskTree2(String additionalCommandLineArguments) This refreshes the task tree.
void	removeRequestObserver(RequestObserverVersion1 observer) Removes a request observer when you no longer wish to receive notifications about Gradle command being executed.
void	setCustomGradleExecutable(File customGradleExecutor) Sets a custom gradle executable.

Methods inherited from interface org.gradle.openapi.external.foundation.GradleInterfaceVersion1

addCommandLineArgumentAlteringListener, executeCommand, getCurrentDirectory, getCustomGradleExecutable, getGradleHomeDirectory, getRootProjects, isBusy, refreshTaskTree, removeCommandLineArgumentAlteringListener, setCurrentDirectory

Method Detail

getVersion

String getVersion()

Returns:

the version of gradle being run. This is basically the version from the jar file.

refreshTaskTree2

RequestVersion1 refreshTaskTree2()

This refreshes the projects and task list.

refreshTaskTree2

RequestVersion1 refreshTaskTree2(String additionalCommandLineArguments)

This refreshes the task tree. Useful if you know you've changed something behind gradle's back or when first displaying this UI.

Parameters:

additionalCommandLineArguments - additional command line arguments to be passed to gradle when refreshing the task tree.

Returns:

the request object. Useful if you want to track its completion via a RequestObserver

executeCommand2

RequestVersion1 executeCommand2(String commandLineArguments,
                              String displayName)

Call this to execute the given gradle command.

Parameters:

commandLineArguments - the command line arguments to pass to gradle.

displayName - the name displayed in the UI for this command

Returns:

the request object. Useful if you want to track its completion via a RequestObserver

executeFavorites

RequestVersion1 executeFavorites(List<FavoriteTaskVersion1> favorites)

Executes several favorites commands at once as a single command. This has the affect of simply concatenating all the favorite command lines into a single line.

Parameters:

favorites - a list of favorites. If just one favorite, it executes it normally. If multiple favorites, it executes them all at once as a single command. This blindly concatenates them so it may wind up with duplicate tasks on the command line.

Returns:

the request object. Useful if you want to track its completion via a RequestObserver

setCustomGradleExecutable

void setCustomGradleExecutable(File customGradleExecutor)

Sets a custom gradle executable. See getCustomGradleExecutable

Parameters:

customGradleExecutor - the path to an executable (or script/batch file)

addRequestObserver

void addRequestObserver(RequestObserverVersion1 observer)

Adds an observer that is notified when Gradle commands are executed and completed.

Parameters:

observer - the observer that is notified

removeRequestObserver

void removeRequestObserver(RequestObserverVersion1 observer)

Removes a request observer when you no longer wish to receive notifications about Gradle command being executed.

Parameters:

observer - the observer to remove