org.gradle.openapi.wrappers.foundation

Class GradleInterfaceWrapperVersion2

java.lang.Object

org.gradle.openapi.wrappers.foundation.GradleInterfaceWrapperVersion1

org.gradle.openapi.wrappers.foundation.GradleInterfaceWrapperVersion2

All Implemented Interfaces:

GradleInterfaceVersion1, GradleInterfaceVersion2

public class GradleInterfaceWrapperVersion2
extends GradleInterfaceWrapperVersion1
implements GradleInterfaceVersion2

Implementation of GradleInterfaceVersion2 meant to help shield external users from internal changes. This adds new functionality to GradleInterfaceWrapperVersion1.

Author:

mhunsicker

Field Summary

Fields inherited from class org.gradle.openapi.wrappers.foundation.GradleInterfaceWrapperVersion1

gradlePluginLord

Constructor Summary

Constructors

Constructor and Description
GradleInterfaceWrapperVersion2(GradlePluginLord gradlePluginLord)

Method Summary

Methods

Modifier and Type	Method and Description
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.
RequestVersion1	refreshTaskTree2() This refreshes the projects and task list.
RequestVersion1	refreshTaskTree2(String additionalCommandLineArguments) This refreshes the task tree.

Methods inherited from class org.gradle.openapi.wrappers.foundation.GradleInterfaceWrapperVersion1

addCommandLineArgumentAlteringListener, addRequestObserver, executeCommand, getCurrentDirectory, getCustomGradleExecutable, getGradleHomeDirectory, getRootProjects, getVersion, isBusy, refreshTaskTree, removeCommandLineArgumentAlteringListener, removeRequestObserver, setCurrentDirectory, setCustomGradleExecutable

Methods inherited from class java.lang.Object

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

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

addRequestObserver, getVersion, removeRequestObserver, setCustomGradleExecutable

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

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

Constructor Detail

GradleInterfaceWrapperVersion2

public GradleInterfaceWrapperVersion2(GradlePluginLord gradlePluginLord)

Method Detail

refreshTaskTree2

public RequestVersion1 refreshTaskTree2()

Description copied from interface: GradleInterfaceVersion2

This refreshes the projects and task list.

Specified by:

refreshTaskTree2 in interface GradleInterfaceVersion2

refreshTaskTree2

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

Specified by:

refreshTaskTree2 in interface GradleInterfaceVersion2

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

public RequestVersion1 executeCommand2(String commandLineArguments,
                              String displayName)

Description copied from interface: GradleInterfaceVersion2

Call this to execute the given gradle command.

Specified by:

executeCommand2 in interface GradleInterfaceVersion2

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

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

Specified by:

executeFavorites in interface GradleInterfaceVersion2

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.

Returns:

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