org.gradle.openapi.wrappers

Class UIWrapperFactory

java.lang.Object

org.gradle.openapi.wrappers.UIWrapperFactory

public class UIWrapperFactory
extends java.lang.Object

This factory instantiates Gradle UIs used in IDE plugins. It is meant to be called via the Open API UIFactory class using reflection. This is because it is called dynamically. It is also meant to help shield a Gradle user from changes to different versions of UI. It does so by using wrappers that can dynamically choose what/how to implement. The wrappers usually use the latest, however, some of the functionality requires a matching Open API jar (which will be included with the plugin trying to use this). If the matching functionality is not found (a NoClassDefFoundError is thrown), it will fall back to earlier versions. This class should not be moved or renamed, nor should its functions be renamed or have arguments added to/removed from them. This is to ensure forward/backward compatibility with multiple versions of IDE plugins. Instead, consider changing the interaction that is passed to the functions as a means of having the caller provide different functionality.

Author:

mhunsicker

Constructor Summary

Constructors

Constructor and Description
UIWrapperFactory()

Method Summary

Methods

Modifier and Type	Method and Description
static DualPaneUIVersion1	createDualPaneUI(DualPaneUIInteractionVersion1 interaction, boolean showDebugInfo) Creates a dual-pane Gradle UI, consisting of a main panel (containing task tree, favorites, etc) and a separate panel containing the output.
static SinglePaneUIVersion1	createSinglePaneUI(SinglePaneUIInteractionVersion1 interaction, boolean showDebugInfo) Creates a single-pane Gradle UI.

Methods inherited from class java.lang.Object

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

Constructor Detail

UIWrapperFactory

public UIWrapperFactory()

Method Detail

createSinglePaneUI

public static SinglePaneUIVersion1 createSinglePaneUI(SinglePaneUIInteractionVersion1 interaction,
                                      boolean showDebugInfo)
                                               throws java.lang.Exception

Creates a single-pane Gradle UI. The main UI and output panes are self-contained.

Parameters:

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:

a single pane UI.

Throws:

java.lang.Exception

createDualPaneUI

public static DualPaneUIVersion1 createDualPaneUI(DualPaneUIInteractionVersion1 interaction,
                                  boolean showDebugInfo)
                                           throws java.lang.Exception

Creates a dual-pane Gradle UI, consisting of a main panel (containing task tree, favorites, etc) and a separate panel containing the output.

Parameters:

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:

a dual pane UI.

Throws:

java.lang.Exception