com.absint.astree

Class FailonSwitch

java.lang.Object

com.absint.astree.FailonSwitch

public class FailonSwitch
extends Object

Helper class for the com.absint.astree.AstreeBuilder. Stores the project-level settings of the fail-on-switch that allows the analyzer to fail a Jenkins projects on

• errors
• errors and alarms classified as true code defects by the user
• errors and alarms uncommented by the user
• errors and alarms
• errors, alarms, and data-flow anomalies

Author:

AbsInt Angewandte Informatik GmbH

Constructor Summary

Constructors

Constructor and Description
FailonSwitch(String failon)

Method Summary

Modifier and Type	Method and Description
boolean	failOnAlarms() Determines whether the configuration is set to fail a build in case a potential runtime error ("alarm") is reported.
boolean	failOnDataflowAnomalies() Determines whether the configuration is set to fail a build in case a data-flow anomaly ("Type D alarm") is reported.
boolean	failOnErrors() Determines whether the configuration is set to fail a build in case a definite runtime error is reported.
String	getFailon() Returns the short name for the currently configured/set situations in which the plugin may fail a build.
void	setFailon(String failon)

Methods inherited from class java.lang.Object

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

Constructor Detail

FailonSwitch

@DataBoundConstructor
public FailonSwitch(String failon)

Method Detail

setFailon

public void setFailon(String failon)

getFailon

public String getFailon()

Returns the short name for the currently configured/set situations in which the plugin may fail a build.
Valid short names are:

• errors
• true-alarms
• uncommented-alarms
• alarms
• data-flow-anomalies

Returns:

java.lang.String

failOnErrors

public boolean failOnErrors()

Determines whether the configuration is set to fail a build in case a definite runtime error is reported.

Returns:

boolean

failOnAlarms

public boolean failOnAlarms()

Determines whether the configuration is set to fail a build in case a potential runtime error ("alarm") is reported.

Returns:

boolean

failOnDataflowAnomalies

public boolean failOnDataflowAnomalies()

Determines whether the configuration is set to fail a build in case a data-flow anomaly ("Type D alarm") is reported.

Returns:

boolean