Package org.apache.maven.plugin.jxr

Class JxrReport

java.lang.Object
org.apache.maven.plugin.AbstractMojo
org.apache.maven.reporting.AbstractMavenReport
org.apache.maven.plugin.jxr.AbstractJxrReport
org.apache.maven.plugin.jxr.JxrReport
All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenMultiPageReport, org.apache.maven.reporting.MavenReport
Direct Known Subclasses:
AggregatorJxrReport, JxrNoForkReport
@Mojo(name="jxr") @Execute(phase=GENERATE_SOURCES) public class JxrReport extends AbstractJxrReport
Creates an html-based, cross referenced version of Java source code for a project.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private String
    destDir
    Directory where the Xref files will be copied to.
    private File
    javadocDir
    Directory where Javadoc is generated for this project.
    private List<String>
    sourceDirs
    Source directories of the project.
    private String
    sourcePath
    Specifies the source path where the java files are located.

    Fields inherited from class org.apache.maven.plugin.jxr.AbstractJxrReport

    reactorProjects, skip

    Fields inherited from class org.apache.maven.reporting.AbstractMavenReport

    locale, mojoExecution, outputDirectory, outputFormat, outputTimestamp, project, remoteProjectRepositories, repoSession, siteDirectory, siteRenderer, siteTool

    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

    Constructors
    Constructor
    Description
    JxrReport()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDescription(Locale locale)
     
    protected String
    getDestinationDirectory()
    Abstract method that returns the target directory where the generated JXR reports will be put.
    protected File
    getJavadocDir()
    Abstract method that returns the directory of the javadoc files.
    String
    getName(Locale locale)
     
    String
    getOutputName()
     
    protected List<String>
    getSourceRoots()
    Abstract method that returns the specified source directories that will be included in the JXR report generation.
    protected List<String>
    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
    void
    setReportOutputDirectory(File reportOutputDirectory)
     

    Methods inherited from class org.apache.maven.plugin.jxr.AbstractJxrReport

    canGenerateReport, constructSourceDirs, executeReport, getBundle, getProject, getSession, init, isAggregate, isExternalReport, pruneSourceDirs

    Methods inherited from class org.apache.maven.reporting.AbstractMavenReport

    closeReport, constructXrefLocation, execute, generate, generate, getCategoryName, getInputEncoding, getLocale, getOutputDirectory, getOutputEncoding, getReportOutputDirectory, getSink, getSinkFactory, getSiteRenderer, getXrefLocation

    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

    getOutputPath

  • Field Details

    • sourceDirs

      @Parameter(defaultValue="${project.compileSourceRoots}", required=true, readonly=true) private List<String> sourceDirs
      Source directories of the project.

    • sourcePath

      @Parameter private String sourcePath
      Specifies the source path where the java files are located. The paths are separated by ';'.

    • destDir

      @Parameter(defaultValue="${project.reporting.outputDirectory}/xref") private String destDir
      Directory where the Xref files will be copied to.

    • javadocDir

      @Parameter(defaultValue="${project.reporting.outputDirectory}/apidocs") private File javadocDir
      Directory where Javadoc is generated for this project.

  • Constructor Details

    • JxrReport

      public JxrReport()

  • Method Details

    • getDestinationDirectory

      protected String getDestinationDirectory()
      Description copied from class: AbstractJxrReport
      Abstract method that returns the target directory where the generated JXR reports will be put.
      Specified by:
      getDestinationDirectory in class AbstractJxrReport
      Returns:
      a String that contains the target directory name

    • getSourceRoots

      protected List<String> getSourceRoots()
      Description copied from class: AbstractJxrReport
      Abstract method that returns the specified source directories that will be included in the JXR report generation.
      Specified by:
      getSourceRoots in class AbstractJxrReport
      Returns:
      a List of the source directories

    • getSourceRoots

      protected List<String> getSourceRoots(org.apache.maven.project.MavenProject project)
      Description copied from class: AbstractJxrReport
      Abstract method that returns the compile source directories of the specified project that will be included in the JXR report generation
      Specified by:
      getSourceRoots in class AbstractJxrReport
      Parameters:
      project - the MavenProject where the JXR report plugin will be executed
      Returns:
      a List of the source directories

    • getDescription

      public String getDescription(Locale locale)

    • getName

      public String getName(Locale locale)

    • getOutputName

      public String getOutputName()

    • getJavadocDir

      protected File getJavadocDir()
      Description copied from class: AbstractJxrReport
      Abstract method that returns the directory of the javadoc files.
      Specified by:
      getJavadocDir in class AbstractJxrReport
      Returns:
      a File for the directory of the javadocs

    • setReportOutputDirectory

      public void setReportOutputDirectory(File reportOutputDirectory)
      Specified by:
      setReportOutputDirectory in interface org.apache.maven.reporting.MavenReport
      Overrides:
      setReportOutputDirectory in class org.apache.maven.reporting.AbstractMavenReport