public interface ActionMapping extends Serializable, Comparable<ActionMapping>
The mapping can cause the action to be disabled: if ActionMapping.getReloadRule()
== ActionMapping.ReloadRule.NEVER
and
ActionMapping.getArgs()
== null
. Such mapping had no effect in previous versions. This can be checked by a
convenience method ActionMapping.isDisabled(org.netbeans.modules.gradle.api.execute.ActionMapping)
.
Modifier and Type | Interface and Description |
---|---|
static class |
ActionMapping.ReloadRule
Rule to reload the project after the Gradle execution.
|
Modifier and Type | Field and Description |
---|---|
static String |
CUSTOM_PREFIX
Prefix fo custom, non-default IDE actions.
|
Modifier and Type | Method and Description |
---|---|
String |
getArgs()
The command line arguments passed to the Gradle process executed as the action.
|
String |
getDisplayName()
The display name only used to present custom actions inside the IDE.
|
String |
getName()
The name of the action, recognizable by the IDE.
|
String |
getReloadArgs()
The command line arguments passed to the Gradle process executed
during the reload after the action execution.
|
ActionMapping.ReloadRule |
getReloadRule()
The reload rule of the action.
|
boolean |
isApplicable(Set<String> plugins)
Returns true if the action can be applicable regarding the provided
set of plugins.
|
static boolean |
isDisabled(ActionMapping am)
Checks if the action is disabled.
|
boolean |
isRepeatable()
Returns true if the action can be repeated after execution.
|
compareTo
static final String CUSTOM_PREFIX
String getName()
ActionMapping.CUSTOM_PREFIX
.String getDisplayName()
String getArgs()
ActionMapping.ReloadRule getReloadRule()
String getReloadArgs()
boolean isApplicable(Set<String> plugins)
plugins
- the set of plugins check the action availability against.boolean isRepeatable()
static boolean isDisabled(ActionMapping am)
actionMapping == null
as it also handles a mapping that forcefully deconfigures an action.am
- action mapping to check