hudson.plugins.jdepend

Class JDependReporter

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.reporting.AbstractMavenReport

org.codehaus.mojo.jdepend.JDependMojo

hudson.plugins.jdepend.JDependReporter

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenReport

public class JDependReporter
extends org.codehaus.mojo.jdepend.JDependMojo

A subclass of JDepend Mojo to create a sink outside of the Maven architecture and generate a report.

Author:

cflewis

Field Summary

Fields

Modifier and Type	Field and Description
protected JDependParser	xmlParser

Fields inherited from interface org.apache.maven.reporting.MavenReport

CATEGORY_PROJECT_INFORMATION, CATEGORY_PROJECT_REPORTS, ROLE

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
JDependReporter(JDependParser xmlParser) Create a new report from the parsed JDepend report

Method Summary

Methods

Modifier and Type	Method and Description
void	generateReport(Locale locale) Deprecated. Use getReport() instead
protected ResourceBundle	getBundle()
String	getReport() Get the HTML report.
String	getReport(Locale locale) Get the HTML report.
protected String	tidyHtmlStream(ByteArrayOutputStream htmlStream) Tidies up the HTML, as the JDepend Sink outputs the HTML all on one line, which is yucky.

Methods inherited from class org.codehaus.mojo.jdepend.JDependMojo

canGenerateReport, executeReport, getArgument, getClassDirectory, getDescription, getName, getOutputDirectory, getOutputName, getProject, getProjectDirectory, getReportFile, getSiteRenderer, setArgument, setClassDirectory, setOutputDirectory, setProject, setProjectDirectory, setReportFile, setSiteRenderer

Methods inherited from class org.apache.maven.reporting.AbstractMavenReport

closeReport, execute, generate, getCategoryName, getReportOutputDirectory, getSink, isExternalReport, setReportOutputDirectory

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Field Detail

xmlParser

protected JDependParser xmlParser

Constructor Detail

JDependReporter

public JDependReporter(JDependParser xmlParser)

Create a new report from the parsed JDepend report

Parameters:

xmlParser - A parsed JDepend report

Method Detail

generateReport

public void generateReport(Locale locale)
                    throws org.apache.maven.reporting.MavenReportException

Deprecated. Use getReport() instead

The old generateReport from the Codehaus JDepend Mojo, no longer used.

Overrides:

generateReport in class org.codehaus.mojo.jdepend.JDependMojo

Throws:

org.apache.maven.reporting.MavenReportException

See Also:

getReport()

tidyHtmlStream

protected String tidyHtmlStream(ByteArrayOutputStream htmlStream)

Tidies up the HTML, as the JDepend Sink outputs the HTML all on one line, which is yucky.

Parameters:

htmlStream -

Returns:

tidied HTML as a String

getReport

public String getReport()
                 throws org.apache.maven.reporting.MavenReportException

Get the HTML report. This report is already run through HTML Tidy.

Returns:

HTML report

Throws:

org.apache.maven.reporting.MavenReportException - when something bad happens

getReport

public String getReport(Locale locale)
                 throws org.apache.maven.reporting.MavenReportException

Get the HTML report. This report is already run through HTML Tidy.

Parameters:

locale -

Returns:

Throws:

org.apache.maven.reporting.MavenReportException

getBundle

protected ResourceBundle getBundle()