org.gradle.gradleplugin.foundation

Class GradlePluginLord

java.lang.Object

org.gradle.gradleplugin.foundation.GradlePluginLord

public class GradlePluginLord
extends Object

This class has nothing to do with plugins inside of gradle, but are related to making a plugin that uses gradle, such as for an IDE. It is also used by the standalone IDE (that way the standalone UI and plugin UIs are kept in synch).

This is the class that stores most of the information that the Gradle plugin works directly with. It is meant to simplify creating a plugin that uses gradle. It maintains a queue of commands to execute and executes them in a separate process due to some complexities with gradle and its dependencies classpaths and potential memory issues.

Author:

mhunsicker

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GradlePluginLord.GeneralPluginObserver
static interface	GradlePluginLord.RequestObserver
static interface	GradlePluginLord.SettingsObserver

Constructor Summary

Constructors

Constructor and Description
GradlePluginLord()

Method Summary

Methods

Modifier and Type	Method and Description
void	addCommandLineArgumentAlteringListener(CommandLineArgumentAlteringListener listener) This allows you to add a listener that can add additional command line arguments whenever gradle is executed.
Request	addExecutionRequestToQueue(List<FavoriteTask> favorites) Executes several favorites commands at once as a single command.
Request	addExecutionRequestToQueue(List<TaskView> tasks, boolean forceOutputToBeShown, String... additionCommandLineOptions) This executes all the tasks together in a background thread.
Request	addExecutionRequestToQueue(String fullCommandLine, String displayName)
Request	addExecutionRequestToQueue(String fullCommandLine, String displayName, boolean forceOutputToBeShown) Call this to execute a task in a background thread.
Request	addExecutionRequestToQueue(TaskView task, boolean forceOutputToBeShown, String... additionCommandLineOptions) This executes a task in a background thread.
void	addGeneralPluginObserver(GradlePluginLord.GeneralPluginObserver observer, boolean inEventQueue) Adds an observer for various events.
Request	addRefreshRequestToQueue() This will refresh the project/task tree.
Request	addRefreshRequestToQueue(String additionalCommandLineArguments) This will refresh the project/task tree.
void	addRequestObserver(GradlePluginLord.RequestObserver observer, boolean inEventQueue)
void	addSettingsObserver(GradlePluginLord.SettingsObserver observer, boolean inEventQueue)
File	getCurrentDirectory()
File	getCustomGradleExecutor()
FavoritesEditor	getFavoritesEditor()
static String	getGradleExceptionMessage(Throwable failure, ShowStacktrace stackTraceLevel) This code was copied from BuildExceptionReporter.reportBuildFailure in gradle's source, then modified slightly to compensate for the fact that we're not driven by options or logging things to a logger object.
File	getGradleHomeDirectory()
LogLevel	getLogLevel()
List<ProjectView>	getProjects()
ShowStacktrace	getStackTraceLevel()
boolean	isBusy() Determines if there are tasks executing or waiting to execute.
boolean	isSetupComplete() Determines if all required setup is complete based on the current settings.
void	removeCommandLineArgumentAlteringListener(CommandLineArgumentAlteringListener listener)
void	removeGeneralPluginObserver(GradlePluginLord.GeneralPluginObserver observer)
void	removeRequestObserver(GradlePluginLord.RequestObserver observer)
void	removeSettingsObserver(GradlePluginLord.SettingsObserver observer)
boolean	setCurrentDirectory(File currentDirectory)
boolean	setCustomGradleExecutor(File customGradleExecutor)
void	setGradleHomeDirectory(File gradleHomeDirectory) sets the gradle home directory.
void	setLogLevel(LogLevel logLevel)
void	setProjects(List<ProjectView> newProjects) Sets the current projects.
void	setStackTraceLevel(ShowStacktrace stackTraceLevel) this allows you to change how much information is given when an error occurs.
void	startExecutionQueue() Call this to start execution.

Methods inherited from class java.lang.Object

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

Constructor Detail

GradlePluginLord

public GradlePluginLord()

Method Detail

getProjects

public List<ProjectView> getProjects()

setProjects

public void setProjects(List<ProjectView> newProjects)

Sets the current projects. This is only supposed to be called by internal gradle classes.

getGradleHomeDirectory

public File getGradleHomeDirectory()

setGradleHomeDirectory

public void setGradleHomeDirectory(File gradleHomeDirectory)

sets the gradle home directory. You can't just set this here. You must also set the "gradle.home" system property. This code could do this for you, but at this time, I didn't want this to have side effects and setting "gradle.home" can affect other things and there may be some timing issues.

Parameters:

gradleHomeDirectory - the new home directory

getCurrentDirectory

public File getCurrentDirectory()

Returns:

the root directory of your gradle project.

setCurrentDirectory

public boolean setCurrentDirectory(File currentDirectory)

Parameters:

currentDirectory - the new root directory of your gradle project.

getCustomGradleExecutor

public File getCustomGradleExecutor()

setCustomGradleExecutor

public boolean setCustomGradleExecutor(File customGradleExecutor)

getFavoritesEditor

public FavoritesEditor getFavoritesEditor()

setStackTraceLevel

public void setStackTraceLevel(ShowStacktrace stackTraceLevel)

this allows you to change how much information is given when an error occurs.

getStackTraceLevel

public ShowStacktrace getStackTraceLevel()

getLogLevel

public LogLevel getLogLevel()

setLogLevel

public void setLogLevel(LogLevel logLevel)

startExecutionQueue

public void startExecutionQueue()

Call this to start execution. This is done after you've initialized everything.

addGeneralPluginObserver

public void addGeneralPluginObserver(GradlePluginLord.GeneralPluginObserver observer,
                            boolean inEventQueue)

Adds an observer for various events. See PluginObserver.

Parameters:

observer - your observer

inEventQueue - true if you want to be notified in the Event Dispatch Thread.

removeGeneralPluginObserver

public void removeGeneralPluginObserver(GradlePluginLord.GeneralPluginObserver observer)

addRequestObserver

public void addRequestObserver(GradlePluginLord.RequestObserver observer,
                      boolean inEventQueue)

removeRequestObserver

public void removeRequestObserver(GradlePluginLord.RequestObserver observer)

addSettingsObserver

public void addSettingsObserver(GradlePluginLord.SettingsObserver observer,
                       boolean inEventQueue)

removeSettingsObserver

public void removeSettingsObserver(GradlePluginLord.SettingsObserver observer)

isSetupComplete

public boolean isSetupComplete()

Determines if all required setup is complete based on the current settings.

Returns:

true if a setup is complete, false if not.

addExecutionRequestToQueue

public Request addExecutionRequestToQueue(String fullCommandLine,
                                 String displayName)

addExecutionRequestToQueue

public Request addExecutionRequestToQueue(TaskView task,
                                 boolean forceOutputToBeShown,
                                 String... additionCommandLineOptions)

This executes a task in a background thread. This creates or uses an existing OutputPanel to display the results.

Parameters:

task - the task to execute.

forceOutputToBeShown - overrides the user setting onlyShowOutputOnErrors so that the output is shown regardless

addExecutionRequestToQueue

public Request addExecutionRequestToQueue(List<TaskView> tasks,
                                 boolean forceOutputToBeShown,
                                 String... additionCommandLineOptions)

This executes all the tasks together in a background thread. That is, all tasks are passed to a single gradle call at once. This creates or uses an existing OutputPanel to display the results.

Parameters:

tasks - the tasks to execute

forceOutputToBeShown - overrides the user setting onlyShowOutputOnErrors so that the output is shown regardless

additionCommandLineOptions - additional command line options to exeucte.

addExecutionRequestToQueue

public Request addExecutionRequestToQueue(List<FavoriteTask> 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.

addExecutionRequestToQueue

public Request addExecutionRequestToQueue(String fullCommandLine,
                                 String displayName,
                                 boolean forceOutputToBeShown)

Call this to execute a task in a background thread. This creates or uses an existing OutputPanel to display the results. This version takes text instead of a task object.

Parameters:

fullCommandLine - the full command line to pass to gradle.

displayName - what we show on the tab.

forceOutputToBeShown - overrides the user setting onlyShowOutputOnErrors so that the output is shown regardless

addRefreshRequestToQueue

public Request addRefreshRequestToQueue()

This will refresh the project/task tree.

Returns:

the Request that was created. Null if no request created.

addRefreshRequestToQueue

public Request addRefreshRequestToQueue(String additionalCommandLineArguments)

This will refresh the project/task tree. This version allows you to specify additional arguments to be passed to gradle during the refresh (such as -b to specify a build file)

Parameters:

additionalCommandLineArguments - the arguments to add, or null if none.

Returns:

the Request that was created. Null if no request created.

addCommandLineArgumentAlteringListener

public void addCommandLineArgumentAlteringListener(CommandLineArgumentAlteringListener 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. param listener the listener that modifies the command line arguments.

removeCommandLineArgumentAlteringListener

public void removeCommandLineArgumentAlteringListener(CommandLineArgumentAlteringListener listener)

getGradleExceptionMessage

public static String getGradleExceptionMessage(Throwable failure,
                               ShowStacktrace stackTraceLevel)

This code was copied from BuildExceptionReporter.reportBuildFailure in gradle's source, then modified slightly to compensate for the fact that we're not driven by options or logging things to a logger object.

isBusy

public boolean isBusy()

Determines if there are tasks executing or waiting to execute. We only care about execution requests, not refresh requests.

Returns:

true if this is busy, false if not.