Field Detail

• reactorProjects

  protected List reactorProjects

  The projects in the reactor for aggregation report.

  Is defined by:

  expression:

  ${reactorProjects}

  Is readonly.

• aggregate

  protected boolean aggregate

  Deprecated. since 2.3. Use the goals jxr:aggregate and jxr:test-aggregate instead.
  Whether to build an aggregated report at the root, or build individual reports.

  Is defined by:

  expression:

  ${aggregate}

  default-value:

  false

• skip

  protected boolean skip

  Whether to skip this execution.

  Since:

  2.3

  Is defined by:

  expression:

  ${maven.jxr.skip}

  default-value:

  false

Constructor Detail

• AbstractJxrReport

  public AbstractJxrReport()

Method Detail

• getOutputEncoding

  protected String getOutputEncoding()

  Gets the effective reporting output files encoding.

  Returns:

  The effective reporting output file encoding, never null: defaults to UTF-8 instead.

• pruneSourceDirs

  protected List pruneSourceDirs(List sourceDirs)

  Compiles the list of directories which contain source files that will be included in the JXR report generation.

  Parameters:

  sourceDirs - the List of the source directories

  Returns:

  a List of the directories that will be included in the JXR report generation

• init

  protected void init()

  Initialize some attributes required during the report generation

• getSiteRenderer

  protected org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()

  Specified by:

  getSiteRenderer in class org.apache.maven.reporting.AbstractMavenReport

  See Also:

  AbstractMavenReport.getSiteRenderer()

• getOutputDirectory

  protected String getOutputDirectory()

  Specified by:

  getOutputDirectory in class org.apache.maven.reporting.AbstractMavenReport

  See Also:

  AbstractMavenReport.getOutputDirectory()

• getProject

  public org.apache.maven.project.MavenProject getProject()

  Specified by:

  getProject in class org.apache.maven.reporting.AbstractMavenReport

  See Also:

  AbstractMavenReport.getProject()

• getBundle

  protected ResourceBundle getBundle(Locale locale)

  Returns the correct resource bundle according to the locale

  Parameters:

  locale - the locale of the user

  Returns:

  the bundle corresponding to the locale

• canGenerateReport

  protected boolean canGenerateReport(List sourceDirs)

  Parameters:

  sourceDirs -

  Returns:

  true if the report could be generated

• execute

  public void execute()
               throws org.apache.maven.plugin.MojoExecutionException

  Specified by:

  execute in interface org.apache.maven.plugin.Mojo

  Overrides:

  execute in class org.apache.maven.reporting.AbstractMavenReport

  Throws:

  org.apache.maven.plugin.MojoExecutionException

• executeReport

  protected void executeReport(Locale locale)
                        throws org.apache.maven.reporting.MavenReportException

  Specified by:

  executeReport in class org.apache.maven.reporting.AbstractMavenReport

  Throws:

  org.apache.maven.reporting.MavenReportException

  See Also:

  AbstractMavenReport.executeReport(java.util.Locale)

• constructSourceDirs

  protected List constructSourceDirs()

  Gets the list of the source directories to be included in the JXR report generation

  Returns:

  a List of the source directories whose contents will be included in the JXR report generation

• canGenerateReport

  public boolean canGenerateReport()

  Specified by:

  canGenerateReport in interface org.apache.maven.reporting.MavenReport

  Overrides:

  canGenerateReport in class org.apache.maven.reporting.AbstractMavenReport

  See Also:

  AbstractMavenReport.canGenerateReport()

• isExternalReport

  public boolean isExternalReport()

  Specified by:

  isExternalReport in interface org.apache.maven.reporting.MavenReport

  Overrides:

  isExternalReport in class org.apache.maven.reporting.AbstractMavenReport

  See Also:

  AbstractMavenReport.isExternalReport()

• getDestinationDirectory

  protected abstract String getDestinationDirectory()

  Abstract method that returns the target directory where the generated JXR reports will be put.

  Returns:

  a String that contains the target directory name

• getSourceRoots

  protected abstract List getSourceRoots()

  Abstract method that returns the specified source directories that will be included in the JXR report generation.

  Returns:

  a List of the source directories

• getSourceRoots

  protected abstract 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

  Parameters:

  project - the MavenProject where the JXR report plugin will be executed

  Returns:

  a List of the source directories

• getJavadocDir

  protected abstract File getJavadocDir()

  Abstract method that returns the directory of the javadoc files.

  Returns:

  a File for the directory of the javadocs

• isAggregate

  protected boolean isAggregate()

  Is the current report aggregated?

  Returns: