hudson.plugins.jdepend

Class JDependRecorder

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Publisher

hudson.tasks.Recorder

hudson.plugins.jdepend.JDependRecorder

All Implemented Interfaces:

ExtensionPoint, Describable<Publisher>, BuildStep

public class JDependRecorder
extends Recorder

Processes JDepend metrics after a build, and outputs them to the a page for the build

Author:

Chris Lewis

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JDependRecorder.DescriptorImpl Descriptor for JDependRecorder.

Nested classes/interfaces inherited from class hudson.tasks.Publisher

Publisher.DescriptorExtensionListImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Nested classes/interfaces inherited from interface hudson.tasks.BuildStep

BuildStep.PublisherList

Field Summary

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor and Description
JDependRecorder(String configuredJDependFile)

Method Summary

Modifier and Type	Method and Description
protected boolean	generateJDependReport(AbstractBuild<?,?> build, Launcher launcher, BuildListener listener) The protected method of generating a JDepend report to allow extensions to override the perform step to add pre/post-stages
String	getConfiguredJDependFile()
JDependParser	getConfiguredParser(AbstractBuild<?,?> build, String configuredPath) Parses a JDepend file that has been generated already
protected JDependParser	getJDependParser(File jDependExistingFile)
protected JDependParser	getJDependParser(File jDependOutputFile, String sourcePath) Gets a location to output a JDepend file, the source to run JDepend on, then returns a parsed version of the JDepend file
Action	getProjectAction(AbstractProject<?,?> project)
BuildStepMonitor	getRequiredMonitorService()
protected void	log(String message) Log output to the given logger, using the JDepend identifier
boolean	perform(AbstractBuild<?,?> build, Launcher launcher, BuildListener listener) This runs a JDepend analysis job when the build is performed.

Methods inherited from class hudson.tasks.Recorder

getDescriptor

Methods inherited from class hudson.tasks.Publisher

all, getProjectAction, needsToRunAfterFinalized, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectActions, perform, prebuild

Methods inherited from class java.lang.Object

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

Constructor Detail

JDependRecorder

@DataBoundConstructor
public JDependRecorder(String configuredJDependFile)

Method Detail

log

protected void log(String message)

Log output to the given logger, using the JDepend identifier

Parameters:

message - The message to be outputted

getConfiguredParser

public JDependParser getConfiguredParser(AbstractBuild<?,?> build,
                                         String configuredPath)

Parses a JDepend file that has been generated already

getJDependParser

protected JDependParser getJDependParser(File jDependOutputFile,
                                         String sourcePath)
                                  throws IOException,
                                         ParserConfigurationException,
                                         SAXException

Gets a location to output a JDepend file, the source to run JDepend on, then returns a parsed version of the JDepend file

Parameters:

jDependOutputFile - the temporary file that JDepend should output to

sourcePath - the path to the source that JDepend should analyze

Returns:

a parsed version of the JDepend output

Throws:

IOException

ParserConfigurationException

SAXException

getJDependParser

protected JDependParser getJDependParser(File jDependExistingFile)
                                  throws ParserConfigurationException,
                                         SAXException,
                                         IOException

Throws:

ParserConfigurationException

SAXException

IOException

generateJDependReport

protected boolean generateJDependReport(AbstractBuild<?,?> build,
                                        Launcher launcher,
                                        BuildListener listener)

The protected method of generating a JDepend report to allow extensions to override the perform step to add pre/post-stages

Parameters:

build -

launcher -

listener -

Returns:

True if report generated successfully.

perform

public boolean perform(AbstractBuild<?,?> build,
                       Launcher launcher,
                       BuildListener listener)

This runs a JDepend analysis job when the build is performed. Gets the location of the workspace (copying to a temp local directory, if needed), then creates the JDepend report and parses it. It then attempts to delete the temporary files afterwards, but if it's not possible, they should be removed by the host OS when it cleans it's temp directories. Warning: Usage on multiple machines, and the copying of data thereof, has not been adequately tested yet.

Specified by:

perform in interface BuildStep

Overrides:

perform in class BuildStepCompatibilityLayer

getProjectAction

public Action getProjectAction(AbstractProject<?,?> project)

Specified by:

getProjectAction in interface BuildStep

Overrides:

getProjectAction in class BuildStepCompatibilityLayer

getConfiguredJDependFile

public String getConfiguredJDependFile()

getRequiredMonitorService

public BuildStepMonitor getRequiredMonitorService()