org.gradle.openapi.wrappers.foundation

Class GradleInterfaceWrapperVersion1

java.lang.Object

org.gradle.openapi.wrappers.foundation.GradleInterfaceWrapperVersion1

All Implemented Interfaces:

GradleInterfaceVersion1

Direct Known Subclasses:

GradleInterfaceWrapperVersion2

public class GradleInterfaceWrapperVersion1
extends Object
implements GradleInterfaceVersion1

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

Author:

mhunsicker

Field Summary

Fields

Modifier and Type	Field and Description
protected GradlePluginLord	gradlePluginLord

Constructor Summary

Constructors

Constructor and Description
GradleInterfaceWrapperVersion1(GradlePluginLord gradlePluginLord)

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	addRequestObserver(RequestObserverVersion1 observer) Adds an observer that is notified when Gradle commands are executed and completed.
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()
String	getVersion()
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	removeRequestObserver(RequestObserverVersion1 observer) Removes a request observer when you no longer wish to receive notifications about Gradle command being executed.
void	setCurrentDirectory(File currentDirectory)
void	setCustomGradleExecutable(File customGradleExecutor) Sets a custom gradle executable.

Methods inherited from class java.lang.Object

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

Field Detail

gradlePluginLord

protected GradlePluginLord gradlePluginLord

Constructor Detail

GradleInterfaceWrapperVersion1

public GradleInterfaceWrapperVersion1(GradlePluginLord gradlePluginLord)

Method Detail

getVersion

public String getVersion()

Returns:

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

getRootProjects

public List<ProjectVersion1> getRootProjects()

Specified by:

getRootProjects in interface GradleInterfaceVersion1

Returns:

the root projects wrapped in a ProjectWrapper

isBusy

public boolean isBusy()

Determines if commands are currently being executed or not. Refreshing tasks is not considered busy.

Specified by:

isBusy in interface GradleInterfaceVersion1

Returns:

true if we're busy, false if not.

refreshTaskTree

public void refreshTaskTree()

Description copied from interface: GradleInterfaceVersion1

This refreshes the projects and task list.

Specified by:

refreshTaskTree in interface GradleInterfaceVersion1

executeCommand

public void executeCommand(String commandLineArguments,
                  String displayName)

Description copied from interface: GradleInterfaceVersion1

Call this to execute the given gradle command.

Specified by:

executeCommand in interface GradleInterfaceVersion1

Parameters:

commandLineArguments - the command line arguments to pass to gradle.

displayName - the name displayed in the UI for this command

getCurrentDirectory

public File getCurrentDirectory()

Specified by:

getCurrentDirectory in interface GradleInterfaceVersion1

Returns:

the root directory of your gradle project.

setCurrentDirectory

public void setCurrentDirectory(File currentDirectory)

Specified by:

setCurrentDirectory in interface GradleInterfaceVersion1

Parameters:

currentDirectory - the new root directory of your gradle project.

getGradleHomeDirectory

public File getGradleHomeDirectory()

Specified by:

getGradleHomeDirectory in interface GradleInterfaceVersion1

Returns:

the gradle home directory. Where gradle is installed.

getCustomGradleExecutable

public File getCustomGradleExecutable()

Description copied from interface: GradleInterfaceVersion1

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.

Specified by:

getCustomGradleExecutable in interface GradleInterfaceVersion1

Returns:

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

setCustomGradleExecutable

public void setCustomGradleExecutable(File customGradleExecutor)

Sets a custom gradle executable. See getCustomGradleExecutable

Parameters:

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

addCommandLineArgumentAlteringListener

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

Specified by:

addCommandLineArgumentAlteringListener in interface GradleInterfaceVersion1

Parameters:

listener - the listener that modifies the command line arguments.

removeCommandLineArgumentAlteringListener

public void removeCommandLineArgumentAlteringListener(CommandLineArgumentAlteringListenerVersion1 listener)

Specified by:

removeCommandLineArgumentAlteringListener in interface GradleInterfaceVersion1

addRequestObserver

public 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

public 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