org.netbeans.modules.gradle.spi.actions

Class DefaultGradleActionsProvider

java.lang.Object

org.netbeans.modules.gradle.spi.actions.DefaultGradleActionsProvider

All Implemented Interfaces:

GradleActionsProvider

public abstract class DefaultGradleActionsProvider
extends Object
implements GradleActionsProvider

Constructor Summary

Constructors

Constructor and Description
DefaultGradleActionsProvider(String... actions)

Method Summary

Modifier and Type	Method and Description
InputStream	defaultActionMapConfig() Provides a declarative action description.
static LookupProvider	forProjectLayer(FileObject fo) Defines a GradleActionsProvider for a project based on layer information.
Set<String>	getSupportedActions() Returns the set of supported actions.
boolean	isActionEnabled(String action, Project project, Lookup context) Determines if an action should be enabled.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultGradleActionsProvider

public DefaultGradleActionsProvider(String... actions)

Method Detail

getSupportedActions

public final Set<String> getSupportedActions()

Description copied from interface: GradleActionsProvider

Returns the set of supported actions. If the Provider supplies actions for a certain GradleExecConfiguration only, it should still report them here.

Specified by:

getSupportedActions in interface GradleActionsProvider

Returns:

set of all supported actions.

isActionEnabled

public boolean isActionEnabled(String action,
                               Project project,
                               Lookup context)

Description copied from interface: GradleActionsProvider

Determines if an action should be enabled. Usually determined by project structure and/or state. The Provider must no answer true for actions it does not support.

Specified by:

isActionEnabled in interface GradleActionsProvider

Parameters:

action - action name

project - the target project

context - context that would be used for action invocation.

Returns:

true, if the action should be enabled.

defaultActionMapConfig

public final InputStream defaultActionMapConfig()

Description copied from interface: GradleActionsProvider

Provides a declarative action description. The returned InputStream must contain XML content conforming to action-mapping.dtd.

An example of an action mapping:

<!DOCTYPE actions SYSTEM "action-mapping.dtd">
<actions>
    <action name="clean">
        <args>clean</args>
    </action>

    <action name="build">
        <args>build</args>
    </action>

    <action name="rebuild">
        <args>clean build</args>
    </action>

    <action name="test">
        <args>--rerun-tasks test</args>
    </action>
</actions>

Starting from version 2.13 the InputStream can contain entries for GradleExecConfigurations.

Example of how configuration is declared in action mapping:

<actions>
    <profiles>
        <profile id="provided-config" displayName="Example Provided Config">
            <property name="propA">value1</property>
            <args>--info</args>
            <actions>
                <apply-for plugins="java">
                    <action name="run.single">
                        <args>-PrunClassName=${selectedClass} runSingle 
                            --continuous ${javaExec.jvmArgs} ${javaExec.args}
                        </args>
                    </action>
                </apply-for>
                <apply-for plugins="application">
                    <action name="run">
                        <args>run --continuous ${javaExec.jvmArgs} 
                            ${javaExec.args}
                        </args>
                    </action>
                </apply-for>
                <action name="debug.single">
                    <reload rule="NEVER"/>
                </action>
            </actions>
        </profile>
    </profiles>

Specified by:

defaultActionMapConfig in interface GradleActionsProvider

Returns:

stream with action description.

forProjectLayer

public static LookupProvider forProjectLayer(FileObject fo)
                                      throws IOException

Defines a GradleActionsProvider for a project based on layer information. It should be invoked for a FileObject from the XML layer, that has the following attributes:

• resource : String - URL of the resource that will be streamed from GradleActionsProvider.defaultActionMapConfig()

An example of how an action or configuration contribution can be declared in the action definition stream:

<actions>
    <profiles>
        <profile id="provided-config" displayName="Example Provided Config">
            <property name="propA">value1</property>
            <args>--info</args>
            <actions>
                <apply-for plugins="java">
                    <action name="run.single">
                        <args>-PrunClassName=${selectedClass} runSingle 
                            --continuous ${javaExec.jvmArgs} ${javaExec.args}
                        </args>
                    </action>
                </apply-for>
                <apply-for plugins="application">
                    <action name="run">
                        <args>run --continuous ${javaExec.jvmArgs} 
                            ${javaExec.args}
                        </args>
                    </action>
                </apply-for>
                <action name="debug.single">
                    <reload rule="NEVER"/>
                </action>
            </actions>
        </profile>
    </profiles>

It can be then included in either Gradle Project's generic Lookup (folder Projects/org-netbeans-modules-gradle/Lookup or in a plugin-specific folder:

<filesystem>
    <folder name="Projects">
        <folder name="org-netbeans-modules-gradle">
            <folder name="Plugins">
                <folder name="java-library-distribution">
                    <folder name="Lookup">
                        <file name="example-actions-provider.instance">
                            <attr name="instanceOf" stringvalue="org.netbeans.spi.project.LookupProvider"/>
                            <attr name="instanceCreate" methodvalue="org.netbeans.modules.gradle.spi.actions.DefaultGradleActionsProvider.forProjectLayer"/>
                            <attr name="service" stringvalue="org.netbeans.modules.gradle.spi.actions.GradleActionsProvider"/>
                            <attr name="resource" stringvalue="nbres:/org/netbeans/modules/gradle/actions/declarative-actions.xml"/>
                        </file>
                    </folder>
                </folder>
            </folder>
        </folder>
    </folder>

Parameters:

fo - the layer file

Returns:

LookupProvider instance that can be inserted into project's Lookup.

Throws:

IOException - in case of an error.

Since:

2.13