Package com.atlassian.bamboo.trigger
Interface TriggerModuleDescriptor
-
- All Superinterfaces:
com.atlassian.plugin.ModuleDescriptor<TriggerActivator>,NameProvider,com.atlassian.plugin.Resourced,com.atlassian.plugin.ScopeAware
- All Known Implementing Classes:
TriggerModuleDescriptorImpl
public interface TriggerModuleDescriptor extends com.atlassian.plugin.ModuleDescriptor<TriggerActivator>, NameProvider
- Since:
- 5.8
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description booleancanTrigger(@NotNull Triggerable triggerable)booleancanTriggerType(@NotNull Class<? extends Triggerable> triggerableType)@Nullable StringgetIconUrl()@Nullable TriggerConfiguratorgetTriggerConfigurator()Retrieves the plugin class responsible for handling user configuration of this plugin.@Nullable TriggerDefinitionExportergetTriggerExporter()Retrieves the plugin class responsible for exporting of user configuration of this plugin.booleanrequiresChangeDetectionOnCompletion()-
Methods inherited from interface com.atlassian.plugin.ModuleDescriptor
destroy, equals, getCompleteKey, getDescription, getDescriptionKey, getDisplayName, getI18nNameKey, getKey, getMinJavaVersion, getModule, getModuleClass, getName, getParams, getPlugin, getPluginKey, hashCode, init, init, isBroken, isEnabled, isEnabledByDefault, isSystemModule, satisfiesMinJavaVersion, setBroken
-
Methods inherited from interface com.atlassian.bamboo.utils.NameProvider
getName
-
-
-
-
Method Detail
-
canTrigger
boolean canTrigger(@NotNull @NotNull Triggerable triggerable)- Returns:
- true iff build strategy is applicable to a Triggerable
-
canTriggerType
boolean canTriggerType(@NotNull @NotNull Class<? extends Triggerable> triggerableType)- Returns:
- true iff build strategy is applicable to a Triggerable of given type
-
requiresChangeDetectionOnCompletion
boolean requiresChangeDetectionOnCompletion()
- Returns:
- true iff plan executions with this trigger available should result in an extra change detection being performed. This is helpful for triggers that might be lost due to concurrency constraints and have no other fallback.
-
getTriggerConfigurator
@Nullable @Nullable TriggerConfigurator getTriggerConfigurator()
Retrieves the plugin class responsible for handling user configuration of this plugin.- Returns:
TriggerConfiguratorfor this ModuleDescriptor
-
getTriggerExporter
@Nullable @Nullable TriggerDefinitionExporter getTriggerExporter()
Retrieves the plugin class responsible for exporting of user configuration of this plugin.- Returns:
TriggerDefinitionExporterfor this ModuleDescriptor- Since:
- 5.14
-
getIconUrl
@Nullable @Nullable String getIconUrl()
-
-