org.gradle.openapi.external.foundation

Interface GradleInterfaceVersion1

All Known Subinterfaces:

GradleInterfaceVersion2

All Known Implementing Classes:

GradleInterfaceWrapperVersion1, GradleInterfaceWrapperVersion2

public interface 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	addCommandLineArgumentAlteringListener(CommandLineArgumentAlteringListenerVersion1 listener) This allows you to add a listener that can add additional command line arguments whenever gradle is executed.
void	executeCommand(String commandLineArguments, String displayName) Call this to execute the given gradle command.
File	getCurrentDirectory()
File	getCustomGradleExecutable() This is called to get a custom gradle executable file.
File	getGradleHomeDirectory()
List<ProjectVersion1>	getRootProjects()
boolean	isBusy() Determines if commands are currently being executed or not.
void	refreshTaskTree() This refreshes the projects and task list.
void	removeCommandLineArgumentAlteringListener(CommandLineArgumentAlteringListenerVersion1 listener)
void	setCurrentDirectory(File currentDirectory)

Method Detail

getRootProjects

List<ProjectVersion1> getRootProjects()

Returns:

the root projects. It probably only has one.

refreshTaskTree

void refreshTaskTree()

This refreshes the projects and task list.

isBusy

boolean isBusy()

Determines if commands are currently being executed or not.

Returns:

true if we're busy, false if not.

executeCommand

void executeCommand(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

getCurrentDirectory

File getCurrentDirectory()

Returns:

the root directory of your gradle project.

setCurrentDirectory

void setCurrentDirectory(File currentDirectory)

Parameters:

currentDirectory - the new root directory of your gradle project.

getGradleHomeDirectory

File getGradleHomeDirectory()

Returns:

the gradle home directory. Where gradle is installed.

getCustomGradleExecutable

File getCustomGradleExecutable()

This is called to get a custom gradle executable file. If you don't run gradle.bat or gradle shell script to run gradle, use this to specify what you do run. Note: we're going to pass it the arguments that we would pass to gradle so if you don't like that, see alterCommandLineArguments. Normally, this should return null.

Returns:

the Executable to run gradle command or null to use the default

addCommandLineArgumentAlteringListener

void addCommandLineArgumentAlteringListener(CommandLineArgumentAlteringListenerVersion1 listener)

This allows you to add a listener that can add additional command line arguments whenever gradle is executed. This is useful if you've customized your gradle build and need to specify, for example, an init script.

Parameters:

listener - the listener that modifies the command line arguments.

removeCommandLineArgumentAlteringListener

void removeCommandLineArgumentAlteringListener(CommandLineArgumentAlteringListenerVersion1 listener)