|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.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
Deprecated. since 2.3. Use the goals jxr:aggregate and jxr:test-aggregate instead. |
protected java.util.List |
reactorProjects
The projects in the reactor for aggregation report. |
protected boolean |
skip
Whether to skip this execution. |
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(java.util.List sourceDirs)
|
protected java.util.List |
constructSourceDirs()
Gets the list of the source directories to be included in the JXR report generation |
protected void |
executeReport(java.util.Locale locale)
|
protected java.util.ResourceBundle |
getBundle(java.util.Locale locale)
Returns the correct resource bundle according to the locale |
protected abstract java.lang.String |
getDestinationDirectory()
Abstract method that returns the target directory where the generated JXR reports will be put. |
protected abstract java.io.File |
getJavadocDir()
Abstract method that returns the directory of the javadoc files. |
protected java.lang.String |
getOutputDirectory()
|
protected java.lang.String |
getOutputEncoding()
Gets the effective reporting output files encoding. |
org.apache.maven.project.MavenProject |
getProject()
|
protected org.apache.maven.doxia.siterenderer.Renderer |
getSiteRenderer()
|
protected abstract java.util.List |
getSourceRoots()
Abstract method that returns the specified source directories that will be included in the JXR report generation. |
protected abstract java.util.List |
getSourceRoots(org.apache.maven.project.MavenProject project)
Abstract method that returns the compile source directories of the specified project that will be included in the JXR report generation |
protected void |
init()
Initialize some attributes required during the report generation |
protected boolean |
isAggregate()
Is the current report aggregated? |
boolean |
isExternalReport()
|
protected java.util.List |
pruneSourceDirs(java.util.List sourceDirs)
Compiles the list of directories which contain source files that will be included in the JXR report generation. |
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 java.util.List reactorProjects
protected boolean aggregate
jxr:aggregate
and jxr:test-aggregate
instead.
protected boolean skip
Constructor Detail |
---|
public AbstractJxrReport()
Method Detail |
---|
protected java.lang.String getOutputEncoding()
null
: defaults to
UTF-8
instead.protected java.util.List pruneSourceDirs(java.util.List sourceDirs)
sourceDirs
- the List of the source directories
protected void init()
protected org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()
getSiteRenderer
in class org.apache.maven.reporting.AbstractMavenReport
AbstractMavenReport.getSiteRenderer()
protected java.lang.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 java.util.ResourceBundle getBundle(java.util.Locale locale)
locale
- the locale of the user
protected boolean canGenerateReport(java.util.List sourceDirs)
sourceDirs
-
protected void executeReport(java.util.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 java.util.List constructSourceDirs()
public boolean canGenerateReport()
canGenerateReport
in interface org.apache.maven.reporting.MavenReport
canGenerateReport
in class org.apache.maven.reporting.AbstractMavenReport
AbstractMavenReport.canGenerateReport()
public boolean isExternalReport()
isExternalReport
in interface org.apache.maven.reporting.MavenReport
isExternalReport
in class org.apache.maven.reporting.AbstractMavenReport
AbstractMavenReport.isExternalReport()
protected abstract java.lang.String getDestinationDirectory()
protected abstract java.util.List getSourceRoots()
protected abstract java.util.List getSourceRoots(org.apache.maven.project.MavenProject project)
project
- the MavenProject where the JXR report plugin will be executed
protected abstract java.io.File getJavadocDir()
protected boolean isAggregate()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |