Package io.jenkins.plugins.coverage.metrics.steps

Class CoverageTool

java.lang.Object

io.jenkins.plugins.coverage.metrics.steps.CoverageTool

All Implemented Interfaces:

Describable<CoverageTool>, Serializable

public class CoverageTool
extends Object
implements Describable<CoverageTool>, Serializable

A coverage tool that can produce a coverage tree by parsing a given report file.

Author:

Ullrich Hafner

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CoverageTool.CoverageToolDescriptor	Descriptor for CoverageTool.
static enum	CoverageTool.Parser	Supported coverage parsers.
static enum	CoverageTool.ParserType	Parser types.

Constructor Summary

Constructors

Constructor	Description
CoverageTool()	Creates a new CoverageTool.

Method Summary

Modifier and Type	Method	Description
String	getActualPattern()	Returns the actual pattern to work with.
CoverageTool.CoverageToolDescriptor	getDescriptor()
String	getDisplayName()
CoverageTool.Parser	getParser()
String	getPattern()
protected Object	readResolve()	Called after deserialization to retain backward compatibility.
void	setParser(CoverageTool.Parser parser)	Sets the parser to be used to read the input files.
void	setPattern(String pattern)	Sets the Ant file-set pattern of files to work with.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

CoverageTool

@DataBoundConstructor
public CoverageTool()

Creates a new CoverageTool.

Method Details

getParser

public CoverageTool.Parser getParser()

setParser

@DataBoundSetter
public void setParser(CoverageTool.Parser parser)

Sets the parser to be used to read the input files.

Parameters:

parser - the parser to use

readResolve

protected Object readResolve()

Called after deserialization to retain backward compatibility.

Returns:

this

setPattern

@DataBoundSetter
public void setPattern(String pattern)

Sets the Ant file-set pattern of files to work with. If the pattern is undefined, then the console log is scanned.

Parameters:

pattern - the pattern to use

getPattern

@CheckForNull
public String getPattern()

getActualPattern

public String getActualPattern()

Returns the actual pattern to work with. If no user-defined pattern is given, then the default pattern is returned.

Returns:

the name

See Also:

• setPattern(String)

toString

public String toString()

Overrides:

toString in class Object

getDescriptor

public CoverageTool.CoverageToolDescriptor getDescriptor()

Specified by:

getDescriptor in interface Describable<CoverageTool>

getDisplayName

public String getDisplayName()