org.apache.maven.plugin.jxr
Class JxrReport

java.lang.Object
  extended by org.apache.maven.plugin.AbstractMojo
      extended by org.apache.maven.reporting.AbstractMavenReport
          extended by org.apache.maven.plugin.jxr.JxrReport
All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenReport

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

MOJO for the JXR report. Creates an html-based, cross referenced version of Java source code for a project.

Author:
Fabrice Bellingard

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
JxrReport()
           
 
Method Summary
protected  void executeReport(java.util.Locale locale)
          Cf.
 java.lang.String getDescription(java.util.Locale locale)
          Cf.
 java.lang.String getName(java.util.Locale locale)
          Cf.
protected  java.lang.String getOutputDirectory()
          Cf.
 java.lang.String getOutputName()
          Cf.
 org.apache.maven.project.MavenProject getProject()
          Cf.
protected  org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()
          Cf.
 
Methods inherited from class org.apache.maven.reporting.AbstractMavenReport
canGenerateReport, 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

JxrReport

public JxrReport()
Method Detail

executeReport

protected void executeReport(java.util.Locale locale)
                      throws org.apache.maven.reporting.MavenReportException
Cf. overriden method documentation.

Specified by:
executeReport in class org.apache.maven.reporting.AbstractMavenReport
Throws:
org.apache.maven.reporting.MavenReportException
See Also:
AbstractMavenReport.executeReport(java.util.Locale)

getSiteRenderer

protected org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()
Cf. overriden method documentation.

Specified by:
getSiteRenderer in class org.apache.maven.reporting.AbstractMavenReport
See Also:
AbstractMavenReport.getSiteRenderer()

getOutputDirectory

protected java.lang.String getOutputDirectory()
Cf. overriden method documentation.

Specified by:
getOutputDirectory in class org.apache.maven.reporting.AbstractMavenReport
See Also:
AbstractMavenReport.getOutputDirectory()

getProject

public org.apache.maven.project.MavenProject getProject()
Cf. overriden method documentation.

Specified by:
getProject in class org.apache.maven.reporting.AbstractMavenReport
See Also:
AbstractMavenReport.getProject()

getDescription

public java.lang.String getDescription(java.util.Locale locale)
Cf. overriden method documentation.

See Also:
MavenReport.getDescription(java.util.Locale)

getName

public java.lang.String getName(java.util.Locale locale)
Cf. overriden method documentation.

See Also:
MavenReport.getName(java.util.Locale)

getOutputName

public java.lang.String getOutputName()
Cf. overriden method documentation.

See Also:
MavenReport.getOutputName()


Copyright © 2005-2008 null. All Rights Reserved.