com.absint.astree

Class AstreeBuilder

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Builder

com.absint.astree.AstreeBuilder

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.tasks.Builder>, hudson.tasks.BuildStep, jenkins.tasks.SimpleBuildStep

public class AstreeBuilder
extends hudson.tasks.Builder
implements jenkins.tasks.SimpleBuildStep

When the user configures the project and enables this builder, Descriptor.newInstance(StaplerRequest) is invoked and a new AstreeBuilder is created. The created instance is persisted to the project configuration XML by using XStream, so this allows you to use instance fields to remember the configuration. When a build is performed, the perform(hudson.model.Run<?, ?>, hudson.FilePath, hudson.Launcher, hudson.model.TaskListener) method will be invoked.

Author:

AbsInt Angewandte Informatik GmbH

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AstreeBuilder.DescriptorImpl Descriptor for AstreeBuilder.

Nested classes/interfaces inherited from interface jenkins.tasks.SimpleBuildStep

jenkins.tasks.SimpleBuildStep.LastBuildAction, jenkins.tasks.SimpleBuildStep.LastBuildActionFactory

Nested classes/interfaces inherited from interface hudson.tasks.BuildStep

hudson.tasks.BuildStep.PublisherList

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor and Description
AstreeBuilder(String dax_file, String analysis_id, String output_dir, boolean skip_analysis, boolean genXMLOverview, boolean genXMLCoverage, boolean genXMLAlarmsByOccurence, boolean genXMLAlarmsByCategory, boolean genXMLAlarmsByFile, boolean genXMLRulechecks, boolean dropAnalysis, boolean genPreprocessOutput, FailonSwitch failonswitch)

Method Summary

Modifier and Type	Method and Description
String	getAnalysis_id() Returns the currently set analysis ID used for the analysis run.
String	getDax_file() Returns the currently set path to the DAX file used for the analysis run.
AstreeBuilder.DescriptorImpl	getDescriptor()
String	getFailon()
String	getOutput_dir() Returns the currently set path used as output directory for the analyses.
boolean	isDropAnalysis() Indicates whether the project is to be deleted on the server after the analysis run.
boolean	isFailonswitch() Indicates whether the analysis run is configured to potentially fail a build.
boolean	isGenPreprocessOutput() Indicates whether the analysis run is configured to produce the (text) preprocess output report.
boolean	isGenXMLAlarmsByCategory() Indicates whether the analysis run is configured to produce the XML alarms-by-category summary.
boolean	isGenXMLAlarmsByFile() Indicates whether the analysis run is configured to produce the XML alarms-by-file summary.
boolean	isGenXMLAlarmsByOccurence() Indicates whether the analysis run is configured to produce the XML alarms-by-occurence summary.
boolean	isGenXMLCoverage() Indicates whether the analysis run is configured to produce the XML coverage summary.
boolean	isGenXMLOverview() Indicates whether the analysis run is configured to produce the XML overview summary.
boolean	isGenXMLRulechecks() Indicates whether the analysis run is configured to produce the XML rule checks summary.
boolean	isSkip_analysis() Indicates whether the analysis run is configured to be temporarily skipped (i.e., no analysis is to be done).
void	perform(hudson.model.Run<?,?> build, hudson.FilePath workspace, hudson.Launcher launcher, hudson.model.TaskListener listener)

Methods inherited from class hudson.tasks.Builder

all, getRequiredMonitorService, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectAction, getProjectAction, getProjectActions, perform, perform, prebuild

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface hudson.tasks.BuildStep

getProjectAction, getProjectActions, getRequiredMonitorService, perform, prebuild

Constructor Detail

AstreeBuilder

@DataBoundConstructor
public AstreeBuilder(String dax_file,
                                           String analysis_id,
                                           String output_dir,
                                           boolean skip_analysis,
                                           boolean genXMLOverview,
                                           boolean genXMLCoverage,
                                           boolean genXMLAlarmsByOccurence,
                                           boolean genXMLAlarmsByCategory,
                                           boolean genXMLAlarmsByFile,
                                           boolean genXMLRulechecks,
                                           boolean dropAnalysis,
                                           boolean genPreprocessOutput,
                                           FailonSwitch failonswitch)

Method Detail

getDax_file

public String getDax_file()

Returns the currently set path to the DAX file used for the analysis run.

Returns:

java.lang.String

getAnalysis_id

public String getAnalysis_id()

Returns the currently set analysis ID used for the analysis run.

Returns:

java.lang.String

getOutput_dir

public String getOutput_dir()

Returns the currently set path used as output directory for the analyses.

Returns:

java.lang.String

isFailonswitch

public boolean isFailonswitch()

Indicates whether the analysis run is configured to potentially fail a build.

Returns:

boolean

getFailon

public String getFailon()

Returns:

java.lang.String

isSkip_analysis

public boolean isSkip_analysis()

Indicates whether the analysis run is configured to be temporarily skipped (i.e., no analysis is to be done).

Returns:

boolean

isGenXMLOverview

public boolean isGenXMLOverview()

Indicates whether the analysis run is configured to produce the XML overview summary.

Returns:

boolean

isGenXMLCoverage

public boolean isGenXMLCoverage()

Indicates whether the analysis run is configured to produce the XML coverage summary.

Returns:

boolean

isGenXMLAlarmsByOccurence

public boolean isGenXMLAlarmsByOccurence()

Indicates whether the analysis run is configured to produce the XML alarms-by-occurence summary.

Returns:

boolean

isGenXMLAlarmsByCategory

public boolean isGenXMLAlarmsByCategory()

Indicates whether the analysis run is configured to produce the XML alarms-by-category summary.

Returns:

boolean

isGenXMLAlarmsByFile

public boolean isGenXMLAlarmsByFile()

Indicates whether the analysis run is configured to produce the XML alarms-by-file summary.

Returns:

boolean

isGenXMLRulechecks

public boolean isGenXMLRulechecks()

Indicates whether the analysis run is configured to produce the XML rule checks summary.

Returns:

boolean

isGenPreprocessOutput

public boolean isGenPreprocessOutput()

Indicates whether the analysis run is configured to produce the (text) preprocess output report.

Returns:

boolean

isDropAnalysis

public boolean isDropAnalysis()

Indicates whether the project is to be deleted on the server after the analysis run.

Returns:

boolean

perform

public void perform(hudson.model.Run<?,?> build,
                    hudson.FilePath workspace,
                    hudson.Launcher launcher,
                    hudson.model.TaskListener listener)

Specified by:

perform in interface jenkins.tasks.SimpleBuildStep

getDescriptor

public AstreeBuilder.DescriptorImpl getDescriptor()

Specified by:

getDescriptor in interface hudson.model.Describable<hudson.tasks.Builder>

Overrides:

getDescriptor in class hudson.tasks.Builder