hudson.plugins.brakeman

Class BrakemanResult

java.lang.Object

hudson.plugins.analysis.core.BuildResult

hudson.plugins.brakeman.BrakemanResult

All Implemented Interfaces:

hudson.model.ModelObject, hudson.plugins.analysis.util.model.AnnotationProvider, Serializable

public class BrakemanResult
extends hudson.plugins.analysis.core.BuildResult

Represents the results of the warning analysis. One instance of this class is persisted for each build via an XML file.

Author:

Maximilian Odendahl

See Also:

Serialized Form

Field Summary

Fields inherited from class hudson.plugins.analysis.core.BuildResult

high, low, normal

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BrakemanResult(hudson.model.Run<?,?> build, String defaultEncoding, hudson.plugins.analysis.core.ParserResult result, boolean usePreviousBuildAsReference, boolean useStableBuildAsReference, Class<? extends hudson.plugins.analysis.core.ResultAction<BrakemanResult>> actionType)
	BrakemanResult(hudson.model.Run<?,?> build, String defaultEncoding, hudson.plugins.analysis.core.ParserResult result, boolean usePreviousBuildAsReference, boolean useStableBuildAsReference, ScanResult scanResult) Creates a new instance of BrakemanResult

Method Summary

Modifier and Type	Method and Description
protected void	configure(com.thoughtworks.xstream.XStream xstream)
protected String	createDeltaMessage()
void	evaluateStatus(hudson.plugins.analysis.core.Thresholds thresholds, boolean useDeltaValues, boolean canComputeNew, hudson.plugins.analysis.util.PluginLogger logger, String url) Updates the build status, i.e.
void	evaluateStatus(hudson.plugins.analysis.core.Thresholds thresholds, boolean useDeltaValues, hudson.plugins.analysis.util.PluginLogger logger, String url)
String	getDisplayName()
protected int	getNumberOfIgnoredAnnotations() Returns Integer of the number of Ignored annotations.
protected int	getNumberOfNonIgnoredAnnotations() Returns Integer of the number of Non-Ignored annotations.
String	getReason()
protected Class<? extends hudson.plugins.analysis.core.ResultAction<? extends hudson.plugins.analysis.core.BuildResult>>	getResultActionType()
protected String	getSerializationFileName()
String	getSummary() Returns a summary message for the summary.jelly file.
protected void	setReason(String reason)

Methods inherited from class hudson.plugins.analysis.core.BuildResult

attachLabelProvider, canUseDeltaValues, createDefaultDeltaMessage, createDefaultSummary, createHistory, createHistory, createUrl, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAnnotations, getApi, getContainer, getDataFile, getDays, getDefaultEncoding, getDelta, getDetails, getDynamic, getErrors, getFixedWarnings, getHeader, getHighDelta, getHighScoreGap, getHistory, getLowDelta, getModules, getNewWarnings, getNormalDelta, getNumberOfAnnotations, getNumberOfAnnotations, getNumberOfAnnotations, getNumberOfFixedWarnings, getNumberOfHighPriorityWarnings, getNumberOfLowPriorityWarnings, getNumberOfModules, getNumberOfNewWarnings, getNumberOfNormalPriorityWarnings, getNumberOfWarnings, getOwner, getPluginResult, getPreviousResult, getPriorities, getProject, getReferenceBuild, getResultIcon, getSuccessfulHighScore, getSuccessfulHighScoreGap, getSuccessfulSinceBuild, getSuccessfulSinceDate, getThresholds, getWarningsDelta, getZeroWarningsHighScore, getZeroWarningsSinceBuild, getZeroWarningsSinceDate, hasAnnotations, hasAnnotations, hasAnnotations, hasError, hasNoAnnotations, hasNoAnnotations, hasNoAnnotations, hasPreviousResult, isCurrent, isNewSuccessfulHighScore, isNewZeroWarningsHighScore, isSuccessful, isSuccessfulTouched, readResolve, serializeAnnotations, setHighWarnings, setLowWarnings, setNormalWarnings, setResult, setWarnings, toString, useOnlyStableBuildsAsReference, usePreviousBuildAsStable

Methods inherited from class java.lang.Object

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

Constructor Detail

BrakemanResult

public BrakemanResult(hudson.model.Run<?,?> build,
                      String defaultEncoding,
                      hudson.plugins.analysis.core.ParserResult result,
                      boolean usePreviousBuildAsReference,
                      boolean useStableBuildAsReference,
                      ScanResult scanResult)

Creates a new instance of BrakemanResult

Parameters:

build - the current build as owner of this action

defaultEncoding - the default encoding to be used when reading and parsing files

result - the parsed result with all annotations

usePreviousBuildAsReference - compare with previous build

useStableBuildAsReference - compare with only stable builds

BrakemanResult

protected BrakemanResult(hudson.model.Run<?,?> build,
                         String defaultEncoding,
                         hudson.plugins.analysis.core.ParserResult result,
                         boolean usePreviousBuildAsReference,
                         boolean useStableBuildAsReference,
                         Class<? extends hudson.plugins.analysis.core.ResultAction<BrakemanResult>> actionType)

Method Detail

configure

protected void configure(com.thoughtworks.xstream.XStream xstream)

Overrides:

configure in class hudson.plugins.analysis.core.BuildResult

getSummary

public String getSummary()

Returns a summary message for the summary.jelly file.

Specified by:

getSummary in class hudson.plugins.analysis.core.BuildResult

Returns:

the summary message

createDeltaMessage

protected String createDeltaMessage()

Overrides:

createDeltaMessage in class hudson.plugins.analysis.core.BuildResult

getSerializationFileName

protected String getSerializationFileName()

Specified by:

getSerializationFileName in class hudson.plugins.analysis.core.BuildResult

getDisplayName

public String getDisplayName()

setReason

protected void setReason(String reason)

getReason

public String getReason()

Overrides:

getReason in class hudson.plugins.analysis.core.BuildResult

evaluateStatus

public void evaluateStatus(hudson.plugins.analysis.core.Thresholds thresholds,
                           boolean useDeltaValues,
                           hudson.plugins.analysis.util.PluginLogger logger,
                           String url)

Overrides:

evaluateStatus in class hudson.plugins.analysis.core.BuildResult

evaluateStatus

public void evaluateStatus(hudson.plugins.analysis.core.Thresholds thresholds,
                           boolean useDeltaValues,
                           boolean canComputeNew,
                           hudson.plugins.analysis.util.PluginLogger logger,
                           String url)

Updates the build status, i.e. sets this plug-in result status field to the corresponding Result. Additionally, the Result of the build that owns this instance of BuildResult will be also changed. This has been overridden to add a different evaluate strategy that evaluates thresholds against non-ignored warnings/annotations.

Overrides:

evaluateStatus in class hudson.plugins.analysis.core.BuildResult

Parameters:

thresholds - the failure thresholds

useDeltaValues - the use delta values when computing the differences

canComputeNew - determines whether new warnings should be computed (with respect to baseline)

logger - the logger

url - the URL of the results

getNumberOfIgnoredAnnotations

protected int getNumberOfIgnoredAnnotations()

Returns Integer of the number of Ignored annotations.

Returns:

result

getNumberOfNonIgnoredAnnotations

protected int getNumberOfNonIgnoredAnnotations()

Returns Integer of the number of Non-Ignored annotations.

Returns:

result

getResultActionType

protected Class<? extends hudson.plugins.analysis.core.ResultAction<? extends hudson.plugins.analysis.core.BuildResult>> getResultActionType()

Specified by:

getResultActionType in class hudson.plugins.analysis.core.BuildResult