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.AbstractJxrReport
              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 AbstractJxrReport

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

Author:
Fabrice Bellingard

Field Summary
 
Fields inherited from class org.apache.maven.plugin.jxr.AbstractJxrReport
aggregate, reactorProjects
 
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
 java.lang.String getDescription(java.util.Locale locale)
          Cf.
protected  java.lang.String getDestinationDirectory()
           
protected  java.lang.String getJavadocLocation()
           
 java.lang.String getName(java.util.Locale locale)
          Cf.
 java.lang.String getOutputName()
          Cf.
protected  java.util.List getSourceRoots()
           
protected  java.util.List getSourceRoots(org.apache.maven.project.MavenProject project)
           
 
Methods inherited from class org.apache.maven.plugin.jxr.AbstractJxrReport
canGenerateReport, canGenerateReport, constructSourceDirs, executeReport, getBundle, getOutputDirectory, getProject, getSiteRenderer, init, isExternalReport, pruneSourceDirs
 
Methods inherited from class org.apache.maven.reporting.AbstractMavenReport
closeReport, execute, generate, getCategoryName, getReportOutputDirectory, getSink, 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

getDestinationDirectory

protected java.lang.String getDestinationDirectory()
Specified by:
getDestinationDirectory in class AbstractJxrReport

getSourceRoots

protected java.util.List getSourceRoots()
Specified by:
getSourceRoots in class AbstractJxrReport

getSourceRoots

protected java.util.List getSourceRoots(org.apache.maven.project.MavenProject project)
Specified by:
getSourceRoots in class AbstractJxrReport

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()

getJavadocLocation

protected java.lang.String getJavadocLocation()
Specified by:
getJavadocLocation in class AbstractJxrReport


Copyright © 2005-2007 Apache Software Foundation. All Rights Reserved.