com.atlassian.bamboo.task.condition

Interface TaskCondition

@ExperimentalApi
 @Internal
public interface TaskCondition

Condition for task. Allows to decide if task should be executed or skipped depending on configuration.

Method Summary

Modifier and Type	Method and Description
boolean	isMet(RuntimeTaskDefinition taskDefinition, Map<String,String> conditionConfiguration, CommonContext commonContext)
Map<String,String>	prepareConfiguration(ActionParametersMap parametersMap)
Map<String,Object>	prepareParametersMap(Map<String,String> configuration, ActionParametersMap parametersMap)
ErrorCollection	validate(ActionParametersMap parametersMap) Validate user input before saving condition configuration.

Method Detail

isMet

boolean isMet(@NotNull
              RuntimeTaskDefinition taskDefinition,
              @NotNull
              Map<String,String> conditionConfiguration,
              @NotNull
              CommonContext commonContext)

Returns:

true if task should be executed.

prepareConfiguration

@NotNull
Map<String,String> prepareConfiguration(@NotNull
                                                 ActionParametersMap parametersMap)

Returns:

configuration parameters to be stored along with task configuration.

prepareParametersMap

@NotNull
Map<String,Object> prepareParametersMap(@NotNull
                                                 Map<String,String> configuration,
                                                 @NotNull
                                                 ActionParametersMap parametersMap)

Parameters:

configuration - - condition configuration from TaskDefinition

parametersMap - - user submitted parameters. Use it to restore configuration in case of validation errors.

Returns:

properties to be used for UI presentation of condition configuration.

validate

@Nullable
ErrorCollection validate(@NotNull
                                   ActionParametersMap parametersMap)

Validate user input before saving condition configuration.