org.codehaus.mojo.jdepend
Class JDependMojo

java.lang.Object
  extended by org.apache.maven.plugin.AbstractMojo
      extended by org.apache.maven.reporting.AbstractMavenReport
          extended by org.codehaus.mojo.jdepend.JDependMojo
All Implemented Interfaces:
ContextEnabled, Mojo, org.apache.maven.reporting.MavenReport

public class JDependMojo
extends org.apache.maven.reporting.AbstractMavenReport

Run JDepend and generate a site report.

Version:
$Id: JDependMojo.java 12355 2010-07-01 20:53:03Z rfscholte $
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.
 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()
           
 org.apache.maven.project.MavenProject getProject()
           
 String getProjectDirectory()
           
 String getReportFile()
           
 org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()
           
 void setArgument(String argument)
           
 void setClassDirectory(String classDirectory)
           
 void setOutputDirectory(String outputDirectory)
           
 void setProject(org.apache.maven.project.MavenProject project)
           
 void setProjectDirectory(String projectDirectory)
           
 void setReportFile(String reportFile)
           
 void setSiteRenderer(org.apache.maven.doxia.siterenderer.Renderer siteRenderer)
           
 
Methods inherited from class org.apache.maven.reporting.AbstractMavenReport
closeReport, execute, generate, generate, generate, getCategoryName, getReportOutputDirectory, getSink, getSinkFactory, 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 org.apache.maven.reporting.MavenReportException
Execute the generate of reports.

Specified by:
executeReport in class org.apache.maven.reporting.AbstractMavenReport
Throws:
org.apache.maven.reporting.MavenReportException

canGenerateReport

public boolean canGenerateReport()
Cf. overriden method documentation.

Specified by:
canGenerateReport in interface org.apache.maven.reporting.MavenReport
Overrides:
canGenerateReport in class org.apache.maven.reporting.AbstractMavenReport
See Also:
MavenReport.canGenerateReport()

generateReport

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

getDescription

public String getDescription(Locale locale)

getName

public String getName(Locale locale)

getOutputName

public String getOutputName()

getProject

public org.apache.maven.project.MavenProject getProject()
Specified by:
getProject in class org.apache.maven.reporting.AbstractMavenReport

setProject

public void setProject(org.apache.maven.project.MavenProject project)

getOutputDirectory

public String getOutputDirectory()
Specified by:
getOutputDirectory in class org.apache.maven.reporting.AbstractMavenReport

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.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()
Specified by:
getSiteRenderer in class org.apache.maven.reporting.AbstractMavenReport

setSiteRenderer

public void setSiteRenderer(org.apache.maven.doxia.siterenderer.Renderer siteRenderer)

getProjectDirectory

public String getProjectDirectory()

setProjectDirectory

public void setProjectDirectory(String projectDirectory)

getClassDirectory

public String getClassDirectory()

setClassDirectory

public void setClassDirectory(String classDirectory)


Copyright © 2006-2011 Codehaus. All Rights Reserved.