com.atlassian.bamboo.quickfilter.rule.plugin

Class LastResultStatusRuleType

java.lang.Object

com.atlassian.bamboo.quickfilter.rule.AbstractQuickFilterRuleType

com.atlassian.bamboo.quickfilter.rule.plugin.LastResultStatusRuleType

All Implemented Interfaces:

InitablePluginModule<QuickFilterRuleTypeModuleDescriptor>, QuickFilterRuleType, DescriptionProvider, NameProvider, BambooPluginModule

public class LastResultStatusRuleType
extends AbstractQuickFilterRuleType
implements QuickFilterRuleType

Quick filter rule that filters plans by their last build result's status.

Field Summary

Fields inherited from class com.atlassian.bamboo.quickfilter.rule.AbstractQuickFilterRuleType

moduleDescriptor, templateRenderer

Constructor Summary

Constructors

Constructor and Description
LastResultStatusRuleType(TemplateRenderer templateRenderer, com.atlassian.struts.TextProvider textProvider)

Method Summary

Modifier and Type	Method and Description
void	addDefaults(Map<String,Object> configuration) Add defaults to quick filter rule configuration.
Set<String>	getConfigurationKeys() Return all configuration keys which should be persisted for a quick filter rule of this type.
String	getDescription() Description of this rule type.
String	getName() Name of this rule type.
boolean	matches(Map<String,Object> configuration, ImmutableTopLevelPlan plan) Checks whether the given plan matches a rule of this type with given configuration.
void	populateContextForEdit(Map<String,Object> configuration, Map<String,Object> context) Populate edit HTML template's context.
ErrorCollection	validate(Map<String,Object> configuration) Validate configuration of a rule of this type.

Methods inherited from class com.atlassian.bamboo.quickfilter.rule.AbstractQuickFilterRuleType

getEditHtml, getKey, init

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

getEditHtml, getKey

Constructor Detail

LastResultStatusRuleType

@Inject
public LastResultStatusRuleType(@NotNull
                                        TemplateRenderer templateRenderer,
                                        @NotNull
                                        com.atlassian.struts.TextProvider textProvider)

Method Detail

getName

@NotNull
public String getName()

Description copied from interface: QuickFilterRuleType

Name of this rule type.

Specified by:

getName in interface QuickFilterRuleType

Specified by:

getName in interface DescriptionProvider

Specified by:

getName in interface NameProvider

getDescription

@Nullable
public String getDescription()

Description copied from interface: QuickFilterRuleType

Description of this rule type.

Specified by:

getDescription in interface QuickFilterRuleType

Specified by:

getDescription in interface DescriptionProvider

getConfigurationKeys

@NotNull
public Set<String> getConfigurationKeys()

Description copied from interface: QuickFilterRuleType

Return all configuration keys which should be persisted for a quick filter rule of this type. If this rule type doesn't require any configuration, return an empty set. Only values of these keys from rule's configuration will be persisted. Keys not found in rule's configuration will be skipped.

Specified by:

getConfigurationKeys in interface QuickFilterRuleType

addDefaults

public void addDefaults(@NotNull
                        Map<String,Object> configuration)

Description copied from interface: QuickFilterRuleType

Add defaults to quick filter rule configuration.

Specified by:

addDefaults in interface QuickFilterRuleType

Parameters:

configuration - rule configuration; the values may only be strings or lists of strings

validate

@NotNull
public ErrorCollection validate(@NotNull
                                         Map<String,Object> configuration)

Description copied from interface: QuickFilterRuleType

Validate configuration of a rule of this type. Return an empty error collection if the configuration is valid.

Specified by:

validate in interface QuickFilterRuleType

Parameters:

configuration - rule configuration; the values may only be strings or lists of strings

matches

public boolean matches(@NotNull
                       Map<String,Object> configuration,
                       @NotNull
                       ImmutableTopLevelPlan plan)

Description copied from interface: QuickFilterRuleType

Checks whether the given plan matches a rule of this type with given configuration.

Specified by:

matches in interface QuickFilterRuleType

Parameters:

configuration - rule configuration; the values may only be strings or lists of strings

plan - plan to test

Returns:

true if plan matches this rule, false otherwise

populateContextForEdit

public void populateContextForEdit(@NotNull
                                   Map<String,Object> configuration,
                                   @NotNull
                                   Map<String,Object> context)

Description copied from class: AbstractQuickFilterRuleType

Populate edit HTML template's context. Will be used in AbstractQuickFilterRuleType.getEditHtml(Map).

Specified by:

populateContextForEdit in class AbstractQuickFilterRuleType

Parameters:

configuration - rule configuration; the values may only be strings or lists of strings

context - initial template's context, might be empty; values may be of any type