org.netbeans.modules.gradle.java.api

Class ProjectActions

java.lang.Object

org.netbeans.modules.gradle.java.api.ProjectActions

public final class ProjectActions
extends Object

Utilities and constants related to Gradle/Java project actions.

Since:

1.12

Field Summary

Fields

Modifier and Type	Field and Description
static String	TOKEN_JAVAEXEC_ARGS Replaceable token for program parameters as a commandline option.
static String	TOKEN_JAVAEXEC_CWD Replaceable token for program working directory.
static String	TOKEN_JAVAEXEC_ENV Replaceable token for program environment variables.
static String	TOKEN_JAVAEXEC_JVMARGS Replaceable token for JVM arguments project property.

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

TOKEN_JAVAEXEC_JVMARGS

public static String TOKEN_JAVAEXEC_JVMARGS

Replaceable token for JVM arguments project property. Generates project property for NB Tooling Gradle plugin, if the extra JVM arguments are present, otherwise generates an empty String. The token is interpolated in action-mapping.xml that can be customized by the user. This feature cooperates with NetBeans Tooling Gradle plugin provided by org.netbeans.gradle module.

The token can be used in action-mapping.xml as followes:

<actions>
    <apply-for plugins="application">
        <action name="run">
            <args>run ${javaExec.jvmArgs} ${javaExec.args}</args>
        </action>

        <action name="debug">
            <args>run --debug-jvm  ${javaExec.jvmArgs} ${javaExec.args}</args>
        </action>
    </apply-for>
</actions>

The Gradle Java project support consumes ExplicitProcessParameters from the action's context Lookup, and populates the replaceable token mapping.

The following code injects a specific system property to the VM configuration, and passes "hello Dolly" parameters to the application as main class' parameters. Project actions can be invoked with custom parameters as in the following example:

ExplicitProcessParameters params = ExplicitProcessParameters.builder().
        args("Frodo").
        launcherArg("-verbose").
        build();
ExplicitProcessParameters params2 = ExplicitProcessParameters.builder().
        args("Baggins").replaceArgs(false).
        launcherArg("-Dcompanion=Sam").
        build();

ActionProvider actions = project.getLookup().lookup(ActionProvider.class);
assert actions != null : "No actions available";
// Invoke the project action, with two explicit params
actions.invokeAction(ActionProvider.COMMAND_RUN, Lookups.fixed(
        params, params2
));

TOKEN_JAVAEXEC_ARGS

public static String TOKEN_JAVAEXEC_ARGS

Replaceable token for program parameters as a commandline option. Generates --args <parameter-list>, if the extra parameters are present, otherwise generates an empty String. See ProjectActions.TOKEN_JAVAEXEC_JVMARGS for code examples.

Since:

1.9

TOKEN_JAVAEXEC_CWD

public static String TOKEN_JAVAEXEC_CWD

Replaceable token for program working directory. Generates project property for NB Tooling Gradle plugin, which is used in action-mapping.xml and can be customized by the user. This feature cooperates with NetBeans Tooling Gradle plugin provided by org.netbeans.gradle module. The Gradle Java project support consumes ExplicitProcessParameters from the action's context Lookup, and populates the replaceable token mapping from ExplicitProcessParameters.getWorkingDirectory().

Since:

1.15

TOKEN_JAVAEXEC_ENV

public static String TOKEN_JAVAEXEC_ENV

Replaceable token for program environment variables. Generates project property for NB Tooling Gradle plugin, which is used in action-mapping.xml and can be customized by the user. This feature cooperates with NetBeans Tooling Gradle plugin provided by org.netbeans.gradle module. The Gradle Java project support consumes ExplicitProcessParameters from the action's context Lookup, and populates the replaceable token mapping from ExplicitProcessParameters.getEnvironmentVariables().

Since:

1.15