|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.maven.plugin.AbstractMojo
org.apache.maven.reporting.AbstractMavenReport
org.apache.maven.plugin.jxr.AbstractJxrReport
public abstract class AbstractJxrReport
Base class for the JXR reports.
Field Summary | |
---|---|
protected boolean |
aggregate
Whether to build an aggregated report at the root, or build individual reports. |
protected List |
reactorProjects
The projects in the reactor for aggregation report. |
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 | |
---|---|
AbstractJxrReport()
|
Method Summary | |
---|---|
boolean |
canGenerateReport()
|
protected boolean |
canGenerateReport(List sourceDirs)
|
protected List |
constructSourceDirs()
|
protected void |
executeReport(Locale locale)
Cf. |
protected ResourceBundle |
getBundle(Locale locale)
Returns the correct resource bundle according to the locale |
protected abstract String |
getDestinationDirectory()
|
protected abstract String |
getJavadocLocation()
|
protected String |
getOutputDirectory()
Cf. |
org.apache.maven.project.MavenProject |
getProject()
Cf. |
protected org.apache.maven.doxia.siterenderer.Renderer |
getSiteRenderer()
Cf. |
protected abstract List |
getSourceRoots()
|
protected abstract List |
getSourceRoots(org.apache.maven.project.MavenProject project)
|
protected void |
init()
Initialize some attributes required during the report generation |
boolean |
isExternalReport()
|
protected List |
pruneSourceDirs(List sourceDirs)
|
Methods inherited from class org.apache.maven.reporting.AbstractMavenReport |
---|
closeReport, execute, generate, generate, generate, getCategoryName, getReportOutputDirectory, getSink, getSinkFactory, 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 |
Methods inherited from interface org.apache.maven.reporting.MavenReport |
---|
getDescription, getName, getOutputName |
Field Detail |
---|
protected List reactorProjects
protected boolean aggregate
Constructor Detail |
---|
public AbstractJxrReport()
Method Detail |
---|
protected List pruneSourceDirs(List sourceDirs)
protected void init()
protected org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()
getSiteRenderer
in class org.apache.maven.reporting.AbstractMavenReport
AbstractMavenReport.getSiteRenderer()
protected String getOutputDirectory()
getOutputDirectory
in class org.apache.maven.reporting.AbstractMavenReport
AbstractMavenReport.getOutputDirectory()
public org.apache.maven.project.MavenProject getProject()
getProject
in class org.apache.maven.reporting.AbstractMavenReport
AbstractMavenReport.getProject()
protected ResourceBundle getBundle(Locale locale)
locale
- :
the locale of the user
protected boolean canGenerateReport(List sourceDirs)
protected void executeReport(Locale locale) throws org.apache.maven.reporting.MavenReportException
executeReport
in class org.apache.maven.reporting.AbstractMavenReport
org.apache.maven.reporting.MavenReportException
AbstractMavenReport.executeReport(java.util.Locale)
protected List constructSourceDirs()
public boolean canGenerateReport()
canGenerateReport
in interface org.apache.maven.reporting.MavenReport
canGenerateReport
in class org.apache.maven.reporting.AbstractMavenReport
public boolean isExternalReport()
isExternalReport
in interface org.apache.maven.reporting.MavenReport
isExternalReport
in class org.apache.maven.reporting.AbstractMavenReport
protected abstract String getDestinationDirectory()
protected abstract List getSourceRoots()
protected abstract List getSourceRoots(org.apache.maven.project.MavenProject project)
protected abstract String getJavadocLocation()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |