hudson.plugins.checkstyle
Class CheckStyleResult

java.lang.Object
  hudson.plugins.checkstyle.util.BuildResult
      hudson.plugins.checkstyle.util.AnnotationsBuildResult
          hudson.plugins.checkstyle.CheckStyleResult

All Implemented Interfaces:

hudson.model.ModelObject, AnnotationProvider, java.io.Serializable

public class CheckStyleResult
extends AnnotationsBuildResult

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

Author:

Ulli Hafner

See Also:

Serialized Form

Field Summary

Fields inherited from class hudson.plugins.checkstyle.util.BuildResult

XSTREAM

Constructor Summary

CheckStyleResult(hudson.model.AbstractBuild<?,?> build, java.lang.String defaultEncoding, ParserResult result)
Creates a new instance of CheckStyleResult.

CheckStyleResult(hudson.model.AbstractBuild<?,?> build, java.lang.String defaultEncoding, ParserResult result, CheckStyleResult previous)
Creates a new instance of CheckStyleResult.

Method Summary

java.lang.String	getDetails() Returns the detail messages for the summary.jelly file.
java.lang.String	getDisplayName()
protected JavaProject	getPreviousResult() Returns the results of the previous build.
protected java.lang.String	getSerializationFileName() Returns the name of the file to store the serialized annotations.
java.lang.String	getSummary() Returns a summary message for the summary.jelly file.
protected boolean	hasPreviousResult() Returns whether a previous build result exists.

Methods inherited from class hudson.plugins.checkstyle.util.AnnotationsBuildResult

getContainer, getDays, getDelta, getDynamic, getFixedWarnings, getHighScoreGap, getNewWarnings, getNumberOfAnnotations, getNumberOfAnnotations, getNumberOfFixedWarnings, getNumberOfNewWarnings, getPriorities, getProject, getZeroWarningsHighScore, getZeroWarningsSinceBuild, getZeroWarningsSinceDate, isNewZeroWarningsHighScore

Methods inherited from class hudson.plugins.checkstyle.util.BuildResult

getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAnnotations, getDataFile, getDefaultEncoding, getErrors, getModules, getNumberOfAnnotations, getNumberOfModules, getOwner, hasAnnotations, hasAnnotations, hasAnnotations, hasError, hasNoAnnotations, hasNoAnnotations, hasNoAnnotations, isCurrent, readResolve

Methods inherited from class java.lang.Object

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

Constructor Detail

CheckStyleResult

public CheckStyleResult(hudson.model.AbstractBuild<?,?> build,
                        java.lang.String defaultEncoding,
                        ParserResult result)

Creates a new instance of CheckStyleResult.

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

CheckStyleResult

public CheckStyleResult(hudson.model.AbstractBuild<?,?> build,
                        java.lang.String defaultEncoding,
                        ParserResult result,
                        CheckStyleResult previous)

Creates a new instance of CheckStyleResult.

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

previous - the result of the previous build

Method Detail

getSummary

public java.lang.String getSummary()

Returns a summary message for the summary.jelly file.

Returns:

the summary message

getDetails

public java.lang.String getDetails()

Returns the detail messages for the summary.jelly file.

Specified by:

getDetails in class AnnotationsBuildResult

Returns:

the summary message

getSerializationFileName

protected java.lang.String getSerializationFileName()

Returns the name of the file to store the serialized annotations.

Specified by:

getSerializationFileName in class BuildResult

Returns:

the name of the file to store the serialized annotations

getDisplayName

public java.lang.String getDisplayName()

getPreviousResult

protected JavaProject getPreviousResult()

Returns the results of the previous build.

Specified by:

getPreviousResult in class AnnotationsBuildResult

Returns:

the result of the previous build, or null if no such build exists

hasPreviousResult

protected boolean hasPreviousResult()

Returns whether a previous build result exists.

Specified by:

hasPreviousResult in class AnnotationsBuildResult

Returns:

true if a previous build result exists.