hudson.plugins.cobertura.targets

Class CoverageResult

java.lang.Object

hudson.plugins.cobertura.targets.CoverageResult

All Implemented Interfaces:

Chartable, Serializable

@ExportedBean(defaultVisibility=2)
public class CoverageResult
extends Object
implements Serializable, Chartable

Coverage result for a specific programming element.

Instances of CoverageResult form a tree structure to progressively represent smaller elements.

Since:

22-Aug-2007 18:47:10

Author:

Stephen Connolly

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
hudson.model.Run<?,?>	owner

Constructor Summary

Constructors

Constructor and Description
CoverageResult(CoverageElement elementType, CoverageResult parent, String name)

Method Summary

Modifier and Type	Method and Description
void	doCoverageHighlightedSource(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)
void	doGraph(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp) Generates the graph that shows the coverage trend up to this report.
hudson.model.Api	getApi()
CoverageResult	getChild(String name)
Set<CoverageElement>	getChildElements() Getter for property 'childElements'.
Set<CoverageMetric>	getChildMetrics(CoverageElement element)
Set<String>	getChildren() Getter for keys of property 'children'.
Set<String>	getChildren(CoverageElement element)
Map<String,CoverageResult>	getChildrenReal() Getter for property 'children'.
Ratio	getCoverage(CoverageMetric metric)
Ratio	getCoverageWithEmpty(CoverageMetric metric)
Object	getDynamic(String token, org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)
CoverageElement	getElement() Getter for property 'element'.
Set<CoverageMetric>	getMetrics() Getter for property 'metrics'.
Set<CoverageMetric>	getMetricsWithEmpty()
String	getName() Getter for property 'name'.
hudson.model.Run<?,?>	getOwner() Getter for property 'owner'.
CoveragePaint	getPaint() Getter for property 'paint'.
Map<String,CoveragePaint>	getPaintedSources() Getter for property 'paintedSources'.
CoverageResult	getParent() Getter for property 'parent'.
List<CoverageResult>	getParents() Getter for property 'parents'.
CoverageResult	getPreviousResult() Getter for property 'previousResult'.
String	getRelativeSourcePath() Getter for property 'relativeSourcePath'.
Map<CoverageMetric,Ratio>	getResults() Getter for property 'results'.
CoverageTree	getResultsAPI() Getter for property 'results'.
String	getSourceFileContent() Getter for property 'sourceFileContent'.
boolean	hasPermission()
boolean	isSourceCodeLevel() Getter for property 'sourceCodeLevel'.
boolean	isSourceFileAvailable() Getter for property 'sourceFileAvailable'.
void	paint(int line, int hits)
void	paint(int line, int hits, int branchHits, int branchTotal)
String	relativeUrl(CoverageResult parent)
void	setOwner(hudson.model.AbstractBuild<?,?> owner)
void	setOwner(hudson.model.Run<?,?> owner) Setter for property 'owner'.
void	setRelativeSourcePath(String relativeSourcePath) Setter for property 'relativeSourcePath'.
void	updateMetric(CoverageMetric metric, Ratio additionalResult)
String	urlTransform(String name)
String	xmlTransform(String name)

Methods inherited from class java.lang.Object

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

Field Detail

owner

public transient hudson.model.Run<?,?> owner

Constructor Detail

CoverageResult

public CoverageResult(CoverageElement elementType,
                      CoverageResult parent,
                      String name)

Method Detail

getRelativeSourcePath

public String getRelativeSourcePath()

Getter for property 'relativeSourcePath'.

Returns:

Value for property 'relativeSourcePath'.

setRelativeSourcePath

public void setRelativeSourcePath(String relativeSourcePath)

Setter for property 'relativeSourcePath'.

Parameters:

relativeSourcePath - Value to set for property 'relativeSourcePath'.

getName

public String getName()

Getter for property 'name'.

Returns:

Value for property 'name'.

getParent

public CoverageResult getParent()

Getter for property 'parent'.

Returns:

Value for property 'parent'.

getElement

public CoverageElement getElement()

Getter for property 'element'.

Returns:

Value for property 'element'.

isSourceCodeLevel

public boolean isSourceCodeLevel()

Getter for property 'sourceCodeLevel'.

Returns:

Value for property 'sourceCodeLevel'.

getPaint

public CoveragePaint getPaint()

Getter for property 'paint'.

Returns:

Value for property 'paint'.

paint

public void paint(int line,
                  int hits)

paint

public void paint(int line,
                  int hits,
                  int branchHits,
                  int branchTotal)

isSourceFileAvailable

public boolean isSourceFileAvailable()

Getter for property 'sourceFileAvailable'.

Returns:

Value for property 'sourceFileAvailable'.

hasPermission

public boolean hasPermission()

getSourceFileContent

public String getSourceFileContent()

Getter for property 'sourceFileContent'.

Returns:

Value for property 'sourceFileContent'.

getParents

public List<CoverageResult> getParents()

Getter for property 'parents'.

Returns:

Value for property 'parents'.

getChildElements

public Set<CoverageElement> getChildElements()

Getter for property 'childElements'.

Returns:

Value for property 'childElements'.

getChildren

public Set<String> getChildren(CoverageElement element)

getChildMetrics

public Set<CoverageMetric> getChildMetrics(CoverageElement element)

getChildren

public Set<String> getChildren()

Getter for keys of property 'children'.

Returns:

Value for keys of property 'children'.

getChildrenReal

public Map<String,CoverageResult> getChildrenReal()

Getter for property 'children'.

Returns:

Value for property 'children'.

getResults

public Map<CoverageMetric,Ratio> getResults()

Getter for property 'results'.

Specified by:

getResults in interface Chartable

Returns:

Value for property 'results'.

getResultsAPI

@Exported(name="results")
public CoverageTree getResultsAPI()

Getter for property 'results'.

Returns:

Value for property 'results'.

urlTransform

public String urlTransform(String name)

xmlTransform

public String xmlTransform(String name)

relativeUrl

public String relativeUrl(CoverageResult parent)

getChild

public CoverageResult getChild(String name)

getCoverage

public Ratio getCoverage(CoverageMetric metric)

getCoverageWithEmpty

public Ratio getCoverageWithEmpty(CoverageMetric metric)

getMetrics

public Set<CoverageMetric> getMetrics()

Getter for property 'metrics'.

Returns:

Value for property 'metrics'.

getMetricsWithEmpty

public Set<CoverageMetric> getMetricsWithEmpty()

updateMetric

public void updateMetric(CoverageMetric metric,
                         Ratio additionalResult)

getOwner

public hudson.model.Run<?,?> getOwner()

Getter for property 'owner'.

Specified by:

getOwner in interface Chartable

Returns:

Value for property 'owner'.

setOwner

public void setOwner(hudson.model.Run<?,?> owner)

Setter for property 'owner'.

Parameters:

owner - Value to set for property 'owner'.

setOwner

public void setOwner(hudson.model.AbstractBuild<?,?> owner)

getPreviousResult

public CoverageResult getPreviousResult()

Getter for property 'previousResult'.

Specified by:

getPreviousResult in interface Chartable

Returns:

Value for property 'previousResult'.

getDynamic

public Object getDynamic(String token,
                         org.kohsuke.stapler.StaplerRequest req,
                         org.kohsuke.stapler.StaplerResponse rsp)
                  throws IOException

Throws:

IOException

doCoverageHighlightedSource

public void doCoverageHighlightedSource(org.kohsuke.stapler.StaplerRequest req,
                                        org.kohsuke.stapler.StaplerResponse rsp)
                                 throws IOException

Throws:

IOException

doGraph

public void doGraph(org.kohsuke.stapler.StaplerRequest req,
                    org.kohsuke.stapler.StaplerResponse rsp)
             throws IOException

Generates the graph that shows the coverage trend up to this report.

Parameters:

req - the stapler request

rsp - the stapler response

Throws:

IOException - from StaplerResponse.sendRedirect2

getPaintedSources

public Map<String,CoveragePaint> getPaintedSources()

Getter for property 'paintedSources'.

Returns:

Value for property 'paintedSources'.

getApi

public hudson.model.Api getApi()