org.netbeans.modules.gradle.api.execute

Class RunUtils

java.lang.Object

org.netbeans.modules.gradle.api.execute.RunUtils

public final class RunUtils
extends Object

Utilities, that allow to invoke Gradle.

Since:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROP_AUGMENTED_BUILD
static String	PROP_COMPILE_ON_SAVE
static String	PROP_DEFAULT_CLI
static String	PROP_INCLUDE_OPEN_PROJECTS
static String	PROP_JDK_PLATFORM

Method Summary

Modifier and Type	Method and Description
static boolean	cancelGradle(RunConfig config) Enable plugins to Cancel a currently running Gradle execution.
static RunConfig	createRunConfig(Project project, String action, String displayName, Lookup context, GradleExecConfiguration cfg, Set<RunConfig.ExecFlag> flags, String... args) Create Gradle execution configuration (context).
static RunConfig	createRunConfig(Project project, String action, String displayName, Set<RunConfig.ExecFlag> flags, String... args) Create Gradle execution configuration (context).
static RunConfig	createRunConfig(Project project, String action, String displayName, String[] args) Deprecated. use RunUtils.createRunConfig(org.netbeans.api.project.Project, java.lang.String, java.lang.String, java.util.Set, java.lang.String...) instead.
static RunConfig	createRunConfigForAction(Project project, String action, String displayName, Lookup context, GradleExecConfiguration cfg, Set<RunConfig.ExecFlag> flags, boolean allowDisabled, String... args) Create Gradle execution configuration (context).
static String[]	evaluateActionArgs(Project project, String action, String argLine, Lookup context) Replace the tokens in argLine provided by the project for the action using the given context;
static File	evaluateGradleDistribution(Project project, boolean forceCompatibility) Deprecated.
static ExecutorTask	executeGradle(RunConfig config, String initialOutput) Executes a Gradle build with the given configuration.
static FileObject	extractFileObjectfromLookup(Lookup lookup)
static FileObject[]	extractFileObjectsfromLookup(Lookup lookup)
static ActionMapping	findActionMapping(Project project, String action, GradleExecConfiguration cfg) Finds an action mapping for the given action and (optional) configuration.
static ProjectActionMappingProvider	findActionProvider(Project p, Lookup context) Returns an action mapping provider for the specified project and context.
static Pair	getActivePlatform(Project project) Deprecated. This method has been deprecated without having a replacement in this module. The current implementation serves binary compatibility purposes only.
static Pair	getActivePlatform(String activePlatformId) Deprecated. This method has been deprecated without having a replacement in this module. The current implementation serves binary compatibility purposes only.
static JavaRuntimeManager.JavaRuntime	getActiveRuntime(Project project) Return the current active JavaRuntime used by the specified project.
static GradleDistributionManager.GradleDistribution	getCompatibleGradleDistribution(Project prj) Returns the GradleDistribution for the given project which is compatible with the JVM runtime, the IDE is running on .
static GradleCommandLine	getDefaultCommandLine(Project project)
static boolean	isAugmentedBuildEnabled(Project project)
static boolean	isCompileOnSaveEnabled(Project project) Deprecated. In order to discourage the usage of this call.
static boolean	isIncludeOpenProjectsEnabled(Project project) Returns true if the include open projects checkbox is marked in the project configuration.
static boolean	isProjectTrusted(Project project, boolean interactive) Check if the given project is trusted for execution.
static void	setActiveRuntime(Project project, JavaRuntimeManager.JavaRuntime runtime) Sets the active JavaRuntime on the specified project root.
static ReplaceTokenProvider	simpleReplaceTokenProvider(String token, String value)

Methods inherited from class java.lang.Object

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

Field Detail

PROP_JDK_PLATFORM

public static final String PROP_JDK_PLATFORM

See Also:

Constant Field Values

PROP_COMPILE_ON_SAVE

public static final String PROP_COMPILE_ON_SAVE

See Also:

Constant Field Values

PROP_AUGMENTED_BUILD

public static final String PROP_AUGMENTED_BUILD

See Also:

Constant Field Values

PROP_INCLUDE_OPEN_PROJECTS

public static final String PROP_INCLUDE_OPEN_PROJECTS

See Also:

Constant Field Values

PROP_DEFAULT_CLI

public static final String PROP_DEFAULT_CLI

See Also:

Constant Field Values

Method Detail

extractFileObjectfromLookup

public static FileObject extractFileObjectfromLookup(Lookup lookup)

extractFileObjectsfromLookup

public static FileObject[] extractFileObjectsfromLookup(Lookup lookup)

executeGradle

public static ExecutorTask executeGradle(RunConfig config,
                                         String initialOutput)

Executes a Gradle build with the given configuration. It can also take an initial message, which is printed to the output tab before the actual execution takes over the output handling.

Parameters:

config - the configuration of the Gradle execution

initialOutput - the initial message to be displayed, can be null for no message.

Returns:

The Gradle Execution task

createRunConfig

public static RunConfig createRunConfig(Project project,
                                        String action,
                                        String displayName,
                                        Set<RunConfig.ExecFlag> flags,
                                        String... args)

Create Gradle execution configuration (context). It applies the default setting from the project and the Global Gradle configuration on the command line.

Parameters:

project - The Gradle project

action - The name of the IDE action that's going to be executed

displayName - The display name of the output tab

flags - Execution flags.

args - Gradle command line arguments

Returns:

the Gradle execution configuration.

Since:

1.5

createRunConfig

public static RunConfig createRunConfig(Project project,
                                        String action,
                                        String displayName,
                                        Lookup context,
                                        GradleExecConfiguration cfg,
                                        Set<RunConfig.ExecFlag> flags,
                                        String... args)

Create Gradle execution configuration (context). It applies the default setting from the project and the Global Gradle configuration on the command line. The passed GradleExecConfiguration is recorded in the RunConfig.getExecConfig(). If null is passed, the active project's configuration is recorded.

Parameters:

project - The Gradle project

action - The name of the IDE action that's going to be executed

displayName - The display name of the output tab

flags - Execution flags.

args - Gradle command line arguments

context - action infocation context

cfg - the desired configuration, or null.

Returns:

the Gradle execution configuration.

Since:

2.13

findActionMapping

public static ActionMapping findActionMapping(Project project,
                                              String action,
                                              GradleExecConfiguration cfg)

Finds an action mapping for the given action and (optional) configuration. The configuration may be null, which means the project's active configuration.

Parameters:

project - the project

action - action name

cfg - optional configuration or null

Returns:

action mapping instance, or null, if the action is not defined for the project or is disabled.

Since:

2.28

createRunConfigForAction

public static RunConfig createRunConfigForAction(Project project,
                                                 String action,
                                                 String displayName,
                                                 Lookup context,
                                                 GradleExecConfiguration cfg,
                                                 Set<RunConfig.ExecFlag> flags,
                                                 boolean allowDisabled,
                                                 String... args)

Create Gradle execution configuration (context). It applies the specified configuration (default / active, if the parameter is null). The RunConfig is further configured using the action mapping for the project action.

Parameters:

project - The Gradle project

action - The name of the IDE action

displayName - The display name of the output tab

flags - Execution flags.

args - Gradle command line arguments

context - action infocation context

cfg - the desired configuration, or null.

Returns:

the Gradle execution configuration.

Since:

2.28

createRunConfig

@Deprecated
public static RunConfig createRunConfig(Project project,
                                                    String action,
                                                    String displayName,
                                                    String[] args)

Deprecated. use RunUtils.createRunConfig(org.netbeans.api.project.Project, java.lang.String, java.lang.String, java.util.Set, java.lang.String...) instead.

Create Gradle execution configuration (context). It applies the default setting from the project and the Global Gradle configuration on the command line.

Parameters:

project - The Gradle project

action - The name of the IDE action that's going to be executed

displayName - The display name of the output tab

args - Gradle command line arguments

Returns:

the Gradle execution configuration.

cancelGradle

public static boolean cancelGradle(RunConfig config)

Enable plugins to Cancel a currently running Gradle execution.

Parameters:

config - the RunConfig with which the Gradle execution has been started.

Returns:

true if the current execution was cancelled successfully, false if the execution was already cancelled or it cannot be cancelled for some reason.

Since:

1.4

getCompatibleGradleDistribution

public static GradleDistributionManager.GradleDistribution getCompatibleGradleDistribution(Project prj)

Returns the GradleDistribution for the given project which is compatible with the JVM runtime, the IDE is running on .

Parameters:

prj - the project

Returns:

The project Gradle distribution or the current tooling distribution if the runtime JVM is not supported by the project specified distribution.

Since:

2.23

isCompileOnSaveEnabled

@Deprecated
public static boolean isCompileOnSaveEnabled(Project project)

Deprecated. In order to discourage the usage of this call.

Compile on Save is a yet to be implemented feature. It's implemetation details and necessity is still a question. Most probably this method is in a wrong place here., kepping it around for binary compatibility only.

Parameters:

project -

Returns:

isAugmentedBuildEnabled

public static boolean isAugmentedBuildEnabled(Project project)

isIncludeOpenProjectsEnabled

public static boolean isIncludeOpenProjectsEnabled(Project project)

Returns true if the include open projects checkbox is marked in the project configuration.

Parameters:

project - the given project.

Returns:

true if the settings has been enabled.

Since:

1.5

isProjectTrusted

public static boolean isProjectTrusted(Project project,
                                       boolean interactive)

Check if the given project is trusted for execution. If the project is not trusted invoking this method can ask for temporal trust for one execution only by displaying a dialog.

Starting with version 2.8, the presence and order of individual options can be customized by branding. This allows integrators to select appropriate choices. The supported options are:

• org.netbeans.modules.gradle.api.execute.TrustProjectOption.TrustOnce - trusts just in this session. Equivalent of ProjectTrust.trustProject(org.netbeans.api.project.Project, boolean) called with permanently = false.
• org.netbeans.modules.gradle.api.execute.TrustProjectOption.PermanentTrust - trusts the project permanently. Equivalent of ProjectTrust.trustProject(org.netbeans.api.project.Project, boolean) called with permanently = true. This option is only present if the passed project is not nulland has ProjectInformation in it.
• org.netbeans.modules.gradle.api.execute.TrustProjectOption.RunAlways - sets total trust in gradle scripts, see GradleSettings.setGradleExecutionRule(org.netbeans.modules.gradle.spi.GradleSettings.GradleExecutionRule).

The presence and order of those options can be altered by keys in Bundle.properties branding in org.netbeans.modules.gradle.api.execute package:

1. if the key does not exist, is empty or has a non-numeric value, the option will be hidden.
2. negative value flags the default (pre-selected) option. Value is treated as positive for ordering. If more negative values are present one of them is selected.
3. the visible options will be selected in ascending order of their numeric values
4. Cancel is always present and is the last one.

Example of branding:

org.netbeans.modules.gradle.api.execute.TrustProjectOption.TrustOnce=1
org.netbeans.modules.gradle.api.execute.TrustProjectOption.PermanentTrust=-2
org.netbeans.modules.gradle.api.execute.TrustProjectOption.RunAlways=3

This branding enables all supported options, and will make the "Trust Permanently" the default one.

Parameters:

project - the project to be checked

interactive - ask for permission from UI.

Returns:

if the execution is trusted.

Since:

2.8 the dialog options can be customized.

getDefaultCommandLine

public static GradleCommandLine getDefaultCommandLine(Project project)

evaluateGradleDistribution

@Deprecated
public static File evaluateGradleDistribution(Project project,
                                                          boolean forceCompatibility)

Deprecated.

evaluateActionArgs

public static String[] evaluateActionArgs(Project project,
                                          String action,
                                          String argLine,
                                          Lookup context)

Replace the tokens in argLine provided by the project for the action using the given context;

Parameters:

project - the that holds the ReplaceTokenProvider-s.

argLine - a string which might hold tokens to be replaced.

action - the action name to do the replacement for. It can be null

context - the context of the action.

Returns:

the argLine where the tokens are replaced.

Since:

2.6

simpleReplaceTokenProvider

public static ReplaceTokenProvider simpleReplaceTokenProvider(String token,
                                                              String value)

findActionProvider

public static ProjectActionMappingProvider findActionProvider(Project p,
                                                              Lookup context)

Returns an action mapping provider for the specified project and context. Specifically supports ProjectConfigurations, so the returned provider will

Parameters:

p - the project

context - the action invocation context

Returns:

action provider suitable for the project/context.

Since:

2.14

getActivePlatform

@Deprecated
public static Pair getActivePlatform(String activePlatformId)

Deprecated. This method has been deprecated without having a replacement in this module. The current implementation serves binary compatibility purposes only.

Returns the active platform id, platform pair used by the project. The platform can be null if the active project platform is broken. As this module is no longer dependent on the java platform module, this method always returns null as a platform since 2.3

Parameters:

activePlatformId - the name of platform used by Ant script or null for default platform.

Returns:

Pair of <acivePlatformId, null>

getActivePlatform

@Deprecated
public static Pair getActivePlatform(Project project)

Deprecated. This method has been deprecated without having a replacement in this module. The current implementation serves binary compatibility purposes only.

Returns the active platform id, platform pair used by the project. The platform can be null if the active project platform is broken. As this module is no longer dependent on the java platform module, this method always returns null as a platform since 2.3

Parameters:

project - the project to check.

Returns:

Pair of <"deprecated", null>

getActiveRuntime

public static JavaRuntimeManager.JavaRuntime getActiveRuntime(Project project)

Return the current active JavaRuntime used by the specified project. JavaRuntime is defined in the root project level. If there is no runtime specified on the root project, then this method would return the default runtime. Usually the one, which is used by the IDE.

It is possible that the ID representing the project runtime, has no associated runtime in the IDE. In this case a broken JavaRuntime would be returned with the ID, that would be used.

Parameters:

project - the project which root project specifies the runtime.

Returns:

the JavaRuntime to be used by the project, could be broken, but not null

Since:

2.32

setActiveRuntime

public static void setActiveRuntime(Project project,
                                    JavaRuntimeManager.JavaRuntime runtime)

Sets the active JavaRuntime on the specified project root.

Parameters:

project - the project , which root project shall be set the runtime on

runtime - The JavaRuntime to activate on the project or null can be used to set the default runtime.

Since:

2.32