CloverBuildProcessor (Atlassian Bamboo 9.0.1 API)

java.lang.Object
- com.atlassian.bamboo.v2.build.BaseBuildConfigurationAwarePlugin
- - com.atlassian.bamboo.v2.build.BaseConfigurablePlugin
  - - com.atlassian.bamboo.v2.build.BaseConfigurableBuildPlugin
    - - com.atlassian.bamboo.clover.builder.coverage.CloverBuildProcessor

All Implemented Interfaces:

CustomBuildProcessor, InitablePluginModule, BambooPluginModule, BuildConfigurationAwarePlugin, ConfigurablePlugin, RenderableBuildConfiguration, AgentBuildTask, BuildTask, Callable<BuildContext>
```
public class CloverBuildProcessor
extends BaseConfigurableBuildPlugin
implements CustomBuildProcessor
```

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CLOVER_BUILD_COVERAGE`
`static String`	`CLOVER_CLASSES`
`static String`	`CLOVER_CONDITIONALS`
`static String`	`CLOVER_COVERAGE_DELTA`
`static String`	`CLOVER_COVERED_CONDITIONALS`
`static String`	`CLOVER_COVERED_ELEMENTS`
`static String`	`CLOVER_COVERED_METHODS`
`static String`	`CLOVER_COVERED_STATEMENTS`
`static String`	`CLOVER_ELEMENTS`
`static String`	`CLOVER_EXISTS`
`static String`	`CLOVER_FILES`
`static String`	`CLOVER_HAS_GLOBAL_LICENSE`
`static String`	`CLOVER_HAS_VALID_GLOBAL_LICENSE`
`static String`	`CLOVER_HISTORICAL`
`static String`	`CLOVER_INTEGRATION` The key for the integration types.
`static String`	`CLOVER_INTEGRATION_AUTO`
`static String`	`CLOVER_INTEGRATION_CUSTOM`
`static String`	`CLOVER_INTEGRATON_TOOL` The key for integration tools.
`static String`	`CLOVER_JSON` The contents of the user's clover.license
`static String`	`CLOVER_LOC`
`static String`	`CLOVER_METHODS`
`static String`	`CLOVER_NCLOC`
`static String`	`CLOVER_OPTIMIZE`
`static String`	`CLOVER_PACKAGES`
`static String`	`CLOVER_REPORT_ARTIFACT_LABEL`
`static String`	`CLOVER_REPORT_ARTIFACT_PREFIX`
`static String`	`CLOVER_STATEMENTS`
`static String`	`COVERAGE_TOOL_ATLASSIAN_CLOVER`
`static String`	`COVERAGE_TOOL_OPENCLOVER`

Fields inherited from class com.atlassian.bamboo.v2.build.BaseConfigurableBuildPlugin
buildContext

Fields inherited from class com.atlassian.bamboo.v2.build.BaseBuildConfigurationAwarePlugin
moduleDescriptor, templateRenderer

Constructor Summary

Constructors
Constructor and Description

CloverBuildProcessor()

Constructors
Constructor and Description
`CloverBuildProcessor()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addDefaultValues(@NotNull BuildConfiguration buildConfiguration)` Extension point for adding default values to the form for `RenderableBuildConfiguration.getEditHtml(com.atlassian.bamboo.ww2.actions.build.admin.create.BuildConfiguration, com.atlassian.bamboo.plan.Plan)`
`@NotNull BuildContext`	`call()` Execute the build task.
`void`	`customizeBuildRequirements(@NotNull PlanKey planKey, @NotNull BuildConfiguration buildConfiguration, @NotNull RequirementSet requirementSet)` This part is executed on server as a part of UI configuration.
`@NotNull Set<String>`	`getConfigurationKeys()`
`protected void`	`populateContextForEdit(@NotNull Map<String,Object> context, @NotNull BuildConfiguration buildConfiguration, @Nullable Plan plan)`
`protected void`	`populateContextForView(@NotNull Map<String,Object> context, @NotNull Plan build)`
`void`	`setArtifactDefinitionManager(ArtifactDefinitionManager artifactDefinitionManager)` Deprecated. since 6.8 use constructor injection or annotation injection
`void`	`setBandanaManager(com.atlassian.bandana.BandanaManager bandanaManager)` Deprecated. since 6.8 use constructor injection or annotation injection
`void`	`setPlanManager(PlanManager planManager)` Deprecated. since 6.8 use constructor injection or annotation injection
`@NotNull ErrorCollection`	`validate(@NotNull BuildConfiguration configuration)` Validates the properties in the `BuildConfiguration` object.

Methods inherited from class com.atlassian.bamboo.v2.build.BaseConfigurableBuildPlugin
init, setTemplateRenderer

Methods inherited from class com.atlassian.bamboo.v2.build.BaseConfigurablePlugin
removeBuildRequirements

Methods inherited from class com.atlassian.bamboo.v2.build.BaseBuildConfigurationAwarePlugin
getEditHtml, getTemplateRenderer, getViewHtml, init, prepareConfigObject

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.v2.build.task.BuildTask
init

Methods inherited from interface com.atlassian.bamboo.v2.build.BuildConfigurationAwarePlugin
isConfigurationMissing, prepareConfigObject

Methods inherited from interface com.atlassian.bamboo.plugin.InitablePluginModule
init

Methods inherited from interface com.atlassian.bamboo.v2.build.RenderableBuildConfiguration
getEditHtml, getViewHtml

- Field Detail
  - CLOVER_EXISTS
```
public static final String CLOVER_EXISTS
```
    See Also:
    
    Constant Field Values
  - CLOVER_INTEGRATION
```
public static final String CLOVER_INTEGRATION
```
    The key for the integration types. Either exists or auto.
    
    See Also:
    
    Constant Field Values
  - CLOVER_INTEGRATION_CUSTOM
```
public static final String CLOVER_INTEGRATION_CUSTOM
```
    See Also:
    
    Constant Field Values
  - CLOVER_INTEGRATION_AUTO
```
public static final String CLOVER_INTEGRATION_AUTO
```
    See Also:
    
    Constant Field Values
  - CLOVER_INTEGRATON_TOOL
```
public static final String CLOVER_INTEGRATON_TOOL
```
    The key for integration tools.
    
    See Also:
    
    Constant Field Values
  - COVERAGE_TOOL_ATLASSIAN_CLOVER
```
public static final String COVERAGE_TOOL_ATLASSIAN_CLOVER
```
    See Also:
    
    Constant Field Values
  - COVERAGE_TOOL_OPENCLOVER
```
public static final String COVERAGE_TOOL_OPENCLOVER
```
    See Also:
    
    Constant Field Values
  - CLOVER_JSON
```
public static final String CLOVER_JSON
```
    The contents of the user's clover.license
    
    See Also:
    
    Constant Field Values
  - CLOVER_HISTORICAL
```
public static final String CLOVER_HISTORICAL
```
    See Also:
    
    Constant Field Values
  - CLOVER_OPTIMIZE
```
public static final String CLOVER_OPTIMIZE
```
    See Also:
    
    Constant Field Values
  - CLOVER_BUILD_COVERAGE
```
public static final String CLOVER_BUILD_COVERAGE
```
    See Also:
    
    Constant Field Values
  - CLOVER_COVERAGE_DELTA
```
public static final String CLOVER_COVERAGE_DELTA
```
    See Also:
    
    Constant Field Values
  - CLOVER_ELEMENTS
```
public static final String CLOVER_ELEMENTS
```
    See Also:
    
    Constant Field Values
  - CLOVER_COVERED_ELEMENTS
```
public static final String CLOVER_COVERED_ELEMENTS
```
    See Also:
    
    Constant Field Values
  - CLOVER_PACKAGES
```
public static final String CLOVER_PACKAGES
```
    See Also:
    
    Constant Field Values
  - CLOVER_CONDITIONALS
```
public static final String CLOVER_CONDITIONALS
```
    See Also:
    
    Constant Field Values
  - CLOVER_COVERED_CONDITIONALS
```
public static final String CLOVER_COVERED_CONDITIONALS
```
    See Also:
    
    Constant Field Values
  - CLOVER_LOC
```
public static final String CLOVER_LOC
```
    See Also:
    
    Constant Field Values
  - CLOVER_NCLOC
```
public static final String CLOVER_NCLOC
```
    See Also:
    
    Constant Field Values
  - CLOVER_STATEMENTS
```
public static final String CLOVER_STATEMENTS
```
    See Also:
    
    Constant Field Values
  - CLOVER_COVERED_STATEMENTS
```
public static final String CLOVER_COVERED_STATEMENTS
```
    See Also:
    
    Constant Field Values
  - CLOVER_FILES
```
public static final String CLOVER_FILES
```
    See Also:
    
    Constant Field Values
  - CLOVER_METHODS
```
public static final String CLOVER_METHODS
```
    See Also:
    
    Constant Field Values
  - CLOVER_COVERED_METHODS
```
public static final String CLOVER_COVERED_METHODS
```
    See Also:
    
    Constant Field Values
  - CLOVER_CLASSES
```
public static final String CLOVER_CLASSES
```
    See Also:
    
    Constant Field Values
  - CLOVER_REPORT_ARTIFACT_PREFIX
```
public static final String CLOVER_REPORT_ARTIFACT_PREFIX
```
    See Also:
    
    Constant Field Values
  - CLOVER_REPORT_ARTIFACT_LABEL
```
public static final String CLOVER_REPORT_ARTIFACT_LABEL
```
    See Also:
    
    Constant Field Values
  - CLOVER_HAS_GLOBAL_LICENSE
```
public static final String CLOVER_HAS_GLOBAL_LICENSE
```
    See Also:
    
    Constant Field Values
  - CLOVER_HAS_VALID_GLOBAL_LICENSE
```
public static final String CLOVER_HAS_VALID_GLOBAL_LICENSE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CloverBuildProcessor
```
public CloverBuildProcessor()
```
- Method Detail
  - call
```
@NotNull
public @NotNull BuildContext call()
                                    throws Exception
```
    Description copied from interface: BuildTask
    
    Execute the build task.
    
    Implementations should regularly check if the calling Thread has been interrupted.
    
    Specified by:
    
    call in interface BuildTask
    
    Specified by:
    
    call in interface Callable<BuildContext>
    
    Throws:
    
    InterruptedException - if the calling Thread has been interrupted.
    
    Exception - A general exception that will be handled.
  - addDefaultValues
```
public void addDefaultValues(@NotNull
                             @NotNull BuildConfiguration buildConfiguration)
```
    Description copied from interface: BuildConfigurationAwarePlugin
    
    Extension point for adding default values to the form for RenderableBuildConfiguration.getEditHtml(com.atlassian.bamboo.ww2.actions.build.admin.create.BuildConfiguration, com.atlassian.bamboo.plan.Plan)
    
    Specified by:
    
    addDefaultValues in interface BuildConfigurationAwarePlugin
    
    Overrides:
    
    addDefaultValues in class BaseBuildConfigurationAwarePlugin
    
    Parameters:
    
    buildConfiguration - -
  - customizeBuildRequirements
```
public void customizeBuildRequirements(@NotNull
                                       @NotNull PlanKey planKey,
                                       @NotNull
                                       @NotNull BuildConfiguration buildConfiguration,
                                       @NotNull
                                       @NotNull RequirementSet requirementSet)
```
    This part is executed on server as a part of UI configuration.
    
    Specified by:
    
    customizeBuildRequirements in interface ConfigurablePlugin
    
    Overrides:
    
    customizeBuildRequirements in class BaseConfigurablePlugin
    
    Parameters:
    
    planKey - key of Plan for which requirements has to be removed.
    
    buildConfiguration - source of information for customizing build requirements
    
    requirementSet - requirements to be customized
  - validate
```
@NotNull
public @NotNull ErrorCollection validate(@NotNull
                                                  @NotNull BuildConfiguration configuration)
```
    Description copied from interface: BuildConfigurationAwarePlugin
    
    Validates the properties in the BuildConfiguration object. The name of the properties match those passed in through the form fragments in RenderableBuildConfiguration.getEditHtml(com.atlassian.bamboo.ww2.actions.build.admin.create.BuildConfiguration, com.atlassian.bamboo.plan.Plan) template.
    
    Specified by:
    
    validate in interface BuildConfigurationAwarePlugin
    
    Overrides:
    
    validate in class BaseBuildConfigurationAwarePlugin
    
    Parameters:
    
    configuration - -
    
    Returns:
    
    ErrorCollection keyed by the field name.
  - getConfigurationKeys
```
@NotNull
public @NotNull Set<String> getConfigurationKeys()
```
  - populateContextForView
```
protected void populateContextForView(@NotNull
                                      @NotNull Map<String,Object> context,
                                      @NotNull
                                      @NotNull Plan build)
```
    Overrides:
    
    populateContextForView in class BaseBuildConfigurationAwarePlugin
  - populateContextForEdit
```
protected void populateContextForEdit(@NotNull
                                      @NotNull Map<String,Object> context,
                                      @NotNull
                                      @NotNull BuildConfiguration buildConfiguration,
                                      @Nullable
                                      @Nullable Plan plan)
```
    Overrides:
    
    populateContextForEdit in class BaseBuildConfigurationAwarePlugin
  - setArtifactDefinitionManager
```
@Deprecated
public void setArtifactDefinitionManager(ArtifactDefinitionManager artifactDefinitionManager)
```
    Deprecated. since 6.8 use constructor injection or annotation injection
  - setBandanaManager
```
@Deprecated
public void setBandanaManager(com.atlassian.bandana.BandanaManager bandanaManager)
```
    Deprecated. since 6.8 use constructor injection or annotation injection
  - setPlanManager
```
@Deprecated
public void setPlanManager(PlanManager planManager)
```
    Deprecated. since 6.8 use constructor injection or annotation injection

Class CloverBuildProcessor

Field Summary

Fields inherited from class com.atlassian.bamboo.v2.build.BaseConfigurableBuildPlugin

Fields inherited from class com.atlassian.bamboo.v2.build.BaseBuildConfigurationAwarePlugin

Constructor Summary

Method Summary

Methods inherited from class com.atlassian.bamboo.v2.build.BaseConfigurableBuildPlugin

Methods inherited from class com.atlassian.bamboo.v2.build.BaseConfigurablePlugin

Methods inherited from class com.atlassian.bamboo.v2.build.BaseBuildConfigurationAwarePlugin

Methods inherited from class java.lang.Object

Methods inherited from interface com.atlassian.bamboo.v2.build.task.BuildTask

Methods inherited from interface com.atlassian.bamboo.v2.build.BuildConfigurationAwarePlugin

Methods inherited from interface com.atlassian.bamboo.plugin.InitablePluginModule

Methods inherited from interface com.atlassian.bamboo.v2.build.RenderableBuildConfiguration

Field Detail

CLOVER_EXISTS

CLOVER_INTEGRATION

CLOVER_INTEGRATION_CUSTOM

CLOVER_INTEGRATION_AUTO

CLOVER_INTEGRATON_TOOL

COVERAGE_TOOL_ATLASSIAN_CLOVER

COVERAGE_TOOL_OPENCLOVER

CLOVER_JSON

CLOVER_HISTORICAL

CLOVER_OPTIMIZE

CLOVER_BUILD_COVERAGE

CLOVER_COVERAGE_DELTA

CLOVER_ELEMENTS

CLOVER_COVERED_ELEMENTS

CLOVER_PACKAGES

CLOVER_CONDITIONALS

CLOVER_COVERED_CONDITIONALS

CLOVER_LOC

CLOVER_NCLOC

CLOVER_STATEMENTS

CLOVER_COVERED_STATEMENTS

CLOVER_FILES

CLOVER_METHODS

CLOVER_COVERED_METHODS

CLOVER_CLASSES

CLOVER_REPORT_ARTIFACT_PREFIX

CLOVER_REPORT_ARTIFACT_LABEL

CLOVER_HAS_GLOBAL_LICENSE

CLOVER_HAS_VALID_GLOBAL_LICENSE

Constructor Detail

CloverBuildProcessor

Method Detail

call

addDefaultValues

customizeBuildRequirements

validate

getConfigurationKeys

populateContextForView

populateContextForEdit

setArtifactDefinitionManager

setBandanaManager

setPlanManager