org.codehaus.mojo.jdepend
Class JDependMojo

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.apache.maven.reporting.AbstractMavenReport
          org.codehaus.mojo.jdepend.JDependMojo

All Implemented Interfaces:

ContextEnabled, MavenReport, Mojo

public class JDependMojo

extends AbstractMavenReport

Run JDepend and generate a site report.

Version:

$Id: JDependMojo.java 6588 2008-03-28 12:22:57Z bentmann $

Author:

aramirez@exist.com

Is defined to be executed in:

phase:

compile

Is defined by the goal name:

generate

Field Summary

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

JDependMojo()

Method Summary

boolean	canGenerateReport() Cf. overriden method documentation.
void	executeReport(Locale locale) Execute the generate of reports.
void	generateReport(Locale locale)
String	getArgument()
String	getClassDirectory()
String	getDescription(Locale locale)
String	getName(Locale locale)
String	getOutputDirectory()
String	getOutputName()
MavenProject	getProject()
String	getProjectDirectory()
String	getReportFile()
org.codehaus.doxia.site.renderer.SiteRenderer	getSiteRenderer()
void	setArgument(String argument)
void	setClassDirectory(String classDirectory)
void	setOutputDirectory(String outputDirectory)
void	setProject(MavenProject project)
void	setProjectDirectory(String projectDirectory)
void	setReportFile(String reportFile)
void	setSiteRenderer(org.codehaus.doxia.site.renderer.SiteRenderer siteRenderer)

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

Constructor Detail

JDependMojo

public JDependMojo()

Method Detail

executeReport

public void executeReport(Locale locale)
                   throws MavenReportException

Execute the generate of reports.

Throws:

MavenReportException

canGenerateReport

public boolean canGenerateReport()

Cf. overriden method documentation.

See Also:

MavenReport.canGenerateReport()

generateReport

public void generateReport(Locale locale)
                    throws MavenReportException

Throws:

MavenReportException

getDescription

public String getDescription(Locale locale)

getName

public String getName(Locale locale)

getOutputName

public String getOutputName()

getProject

public MavenProject getProject()

setProject

public void setProject(MavenProject project)

getOutputDirectory

public String getOutputDirectory()

setOutputDirectory

public void setOutputDirectory(String outputDirectory)

getArgument

public String getArgument()

setArgument

public void setArgument(String argument)

getReportFile

public String getReportFile()

setReportFile

public void setReportFile(String reportFile)

getSiteRenderer

public org.codehaus.doxia.site.renderer.SiteRenderer getSiteRenderer()

setSiteRenderer

public void setSiteRenderer(org.codehaus.doxia.site.renderer.SiteRenderer siteRenderer)

getProjectDirectory

public String getProjectDirectory()

setProjectDirectory

public void setProjectDirectory(String projectDirectory)

getClassDirectory

public String getClassDirectory()

setClassDirectory

public void setClassDirectory(String classDirectory)