org.netbeans.modules.gradle.spi.actions

Interface ProjectActionMappingProvider

public interface ProjectActionMappingProvider

An implementation of this interface can be registered in the Gradle project lookup. Gradle support already has an implementation using GradleActionsProvider-s.

This interface also can be used to query the Gradle command line arguments used for a specific action. Like:

     Project project = some Gradle project
     String action = some IDE action
     Lookup context = Lookups.singleton(project); // The context of the action, it is advised to have the project in the context.
     ProjectActionMappingProvider pamp = project.getLookup().lookup(ProjectActionMappingProvider.class);
     ActionMapping actionMapping = pamp.findMapping(action);
     GradleCommandLine cli = new GradleCommandLine(
             RunUtils.evaluateActionArgs(project, actionMapping.getArgs(), action, context));
 

Since 2.14, the Provider may return a disabled ActionMapping. Check using ActionMapping.isDisabled(org.netbeans.modules.gradle.api.execute.ActionMapping), rather than just == null.

Since:

2.6, 2.14 support for disabling an action

Method Summary

Modifier and Type	Method and Description
Set<String>	customizedActions() Get the list of those actions which has been customized.
ActionMapping	findMapping(String action) Try to find an ActionMapping for the given action.

Method Detail

findMapping

ActionMapping findMapping(String action)

Try to find an ActionMapping for the given action. If no mapping has been found it returns null.

Parameters:

action - the action name

Returns:

the action mapping for the action or null if none found

customizedActions

Set<String> customizedActions()

Get the list of those actions which has been customized.

Returns:

the list of customized action names.