Class AbstractQuickFilterRuleType
- java.lang.Object
-
- com.atlassian.bamboo.quickfilter.rule.AbstractQuickFilterRuleType
-
- All Implemented Interfaces:
InitablePluginModule<QuickFilterRuleTypeModuleDescriptor>
,QuickFilterRuleType
,DescriptionProvider
,NameProvider
,BambooPluginModule
- Direct Known Subclasses:
HasLabelRuleType
,InProjectRuleType
,LastExecutionDateRuleType
,LastResultStatusRuleType
,NameMatcherRuleType
,SuspensionStatusRuleType
public abstract class AbstractQuickFilterRuleType extends Object implements QuickFilterRuleType, InitablePluginModule<QuickFilterRuleTypeModuleDescriptor>
-
-
Field Summary
Fields Modifier and Type Field Description protected QuickFilterRuleTypeModuleDescriptor
moduleDescriptor
protected TemplateRenderer
templateRenderer
-
Constructor Summary
Constructors Modifier Constructor Description protected
AbstractQuickFilterRuleType(@NotNull TemplateRenderer templateRenderer)
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description @Nullable String
getEditHtml(@NotNull Map<String,Object> configuration)
Get rendered HTML snippet for editing configuration of this rule type.@NotNull String
getKey()
Complete plugin module key of this rule type.void
init(@NotNull QuickFilterRuleTypeModuleDescriptor moduleDescriptor)
Initialises the Plugin with the plugin module descriptorprotected abstract void
populateContextForEdit(@NotNull Map<String,Object> configuration, @NotNull Map<String,Object> context)
Populate edit HTML template's context.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.atlassian.bamboo.quickfilter.rule.QuickFilterRuleType
addDefaults, getConfigurationKeys, getDescription, getName, matches, validate
-
-
-
-
Field Detail
-
templateRenderer
protected final TemplateRenderer templateRenderer
-
moduleDescriptor
protected QuickFilterRuleTypeModuleDescriptor moduleDescriptor
-
-
Constructor Detail
-
AbstractQuickFilterRuleType
protected AbstractQuickFilterRuleType(@NotNull @NotNull TemplateRenderer templateRenderer)
-
-
Method Detail
-
init
public void init(@NotNull @NotNull QuickFilterRuleTypeModuleDescriptor moduleDescriptor)
Description copied from interface:InitablePluginModule
Initialises the Plugin with the plugin module descriptor- Specified by:
init
in interfaceInitablePluginModule<QuickFilterRuleTypeModuleDescriptor>
- Parameters:
moduleDescriptor
- Plugin module descriptor
-
getKey
@NotNull public @NotNull String getKey()
Description copied from interface:QuickFilterRuleType
Complete plugin module key of this rule type.- Specified by:
getKey
in interfaceQuickFilterRuleType
-
populateContextForEdit
protected abstract void populateContextForEdit(@NotNull @NotNull Map<String,Object> configuration, @NotNull @NotNull Map<String,Object> context)
Populate edit HTML template's context. Will be used ingetEditHtml(Map)
.- Parameters:
configuration
- rule configuration; the values may only be strings or lists of stringscontext
- initial template's context, might be empty; values may be of any type
-
getEditHtml
@Nullable public @Nullable String getEditHtml(@NotNull @NotNull Map<String,Object> configuration)
Description copied from interface:QuickFilterRuleType
Get rendered HTML snippet for editing configuration of this rule type. Return null if this rule doesn't require configuration by user.- Specified by:
getEditHtml
in interfaceQuickFilterRuleType
- Parameters:
configuration
- configuration of this rule, might be empty (but still non null) on initial call; the values may only be strings or lists of strings
-
-