org.gradle.openapi.external.ui

Class UIFactory

java.lang.Object

org.gradle.openapi.external.ui.UIFactory

public class UIFactory
extends Object

This loads up the main gradle UI. This is intended to be used as a plugin inside another application (like an IDE) in a dynamic fashion. If you're always going to ship the entire plugin with the entire Gradle dist, you don't need to use this. This is meant to dynamically load Gradle from its dist. The idea is that you point your plugin to a Gradle dist and then can always load the latest version.

Author:

mhunsicker

Constructor Summary

Constructors

Constructor and Description
UIFactory()

Method Summary

Methods

Modifier and Type	Method and Description
static DualPaneUIVersion1	createDualPaneUI(ClassLoader parentClassLoader, File gradleHomeDirectory, DualPaneUIInteractionVersion1 interaction, boolean showDebugInfo) Deprecated. Use the tooling API instead.
static DualPaneUIVersion1	createDualPaneUIViaFactory(ClassLoader parentClassLoader, File gradleHomeDirectory, DualPaneUIInteractionVersion1 interaction, boolean showDebugInfo) Deprecated. Use the tooling API instead.
static SinglePaneUIVersion1	createSinglePaneUI(ClassLoader parentClassLoader, File gradleHomeDirectory, SinglePaneUIInteractionVersion1 interaction, boolean showDebugInfo) Deprecated. Use the tooling API instead.

Methods inherited from class java.lang.Object

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

Constructor Detail

UIFactory

public UIFactory()

Method Detail

createSinglePaneUI

@Deprecated
public static SinglePaneUIVersion1 createSinglePaneUI(ClassLoader parentClassLoader,
                                                 File gradleHomeDirectory,
                                                 SinglePaneUIInteractionVersion1 interaction,
                                                 boolean showDebugInfo)
                                               throws Exception

Deprecated. Use the tooling API instead.

Call this to instantiate a self-contained gradle UI. That is, everything in the UI is in a single panel (versus 2 panels one for the tasks and one for the output). This will load gradle via reflection, instantiate the UI and all required gradle-related classes.

Note: this function is meant to be backward and forward compatible. So this signature should not change at all, however, it may take and return objects that implement ADDITIONAL interfaces. That is, it will always return SinglePaneUIVersion1, but it may also be an object that implements SinglePaneUIVersion2 (notice the 2). The caller will need to dynamically determine that. The SinglePaneUIInteractionVersion1 may take an object that also implements SinglePaneUIInteractionVersion2. If so, we'll dynamically determine that and handle it. Of course, this all depends on what happens in the future.

Parameters:

parentClassLoader - Your classloader. Probably the classloader of whatever class is calling this.

gradleHomeDirectory - the root directory of a gradle installation

showDebugInfo - true to show some additional information that may be helpful diagnosing problems is this fails

Returns:

the UI object.

Throws:

Exception

createDualPaneUI

@Deprecated
public static DualPaneUIVersion1 createDualPaneUI(ClassLoader parentClassLoader,
                                             File gradleHomeDirectory,
                                             DualPaneUIInteractionVersion1 interaction,
                                             boolean showDebugInfo)
                                           throws Exception

Deprecated. Use the tooling API instead.

Call this to instantiate a gradle UI that contains the main tab control separate from the output panel. This allows you to position the output however you like. For example: you can place the main pane along the side going vertically and you can place the output pane along the bottom going horizontally. This will load gradle via reflection, instantiate the UI and all required gradle-related classes.

Note: this function is meant to be backward and forward compatible. So this signature should not change at all, however, it may take and return objects that implement ADDITIONAL interfaces. That is, it will always return SinglePaneUIVersion1, but it may also be an object that implements SinglePaneUIVersion2 (notice the 2). The caller will need to dynamically determine that. The SinglePaneUIInteractionVersion1 may take an object that also implements SinglePaneUIInteractionVersion2. If so, we'll dynamically determine that and handle it. Of course, this all depends on what happens in the future.

Parameters:

parentClassLoader - Your classloader. Probably the classloader of whatever class is calling this.

gradleHomeDirectory - the root directory of a gradle installation

interaction - this is how we interact with the caller.

showDebugInfo - true to show some additional information that may be helpful diagnosing problems is this fails

Returns:

the UI object.

Throws:

Exception

createDualPaneUIViaFactory

@Deprecated
public static DualPaneUIVersion1 createDualPaneUIViaFactory(ClassLoader parentClassLoader,
                                                       File gradleHomeDirectory,
                                                       DualPaneUIInteractionVersion1 interaction,
                                                       boolean showDebugInfo)
                                                     throws Exception

Deprecated. Use the tooling API instead.

This function uses a factory to instantiate the UI. The factory is located with the version of gradle pointed to by gradleHomeDirectory and thus allows the version of gradle being loaded to make decisions about how to instantiate the UI. This is needed as multiple versions of the UI are being used.

Throws:

Exception