Field Detail

• siteTool

  @Component
  protected SiteTool siteTool

  SiteTool component.

  Since:

  2.1

• siteRenderer

  @Component
  protected Renderer siteRenderer

  Doxia Site Renderer component.

• resolver

  @Component
  protected ArtifactResolver resolver

  Artifact Resolver component.

• factory

  @Component
  protected org.apache.maven.artifact.factory.ArtifactFactory factory

  Artifact Factory component.

• mavenProjectBuilder

  @Component
  protected org.apache.maven.project.MavenProjectBuilder mavenProjectBuilder

  Project builder.

• outputDirectory

  @Parameter(property="project.reporting.outputDirectory",
             required=true)
  protected File outputDirectory

  The output directory for the report. Note that this parameter is only evaluated if the goal is run directly from the command line. If the goal is run indirectly as part of a site generation, the output directory configured in the Maven Site Plugin is used instead.

• project

  @Parameter(defaultValue="${project}",
             readonly=true,
             required=true)
  protected org.apache.maven.project.MavenProject project

  The Maven Project.

• localRepository

  @Parameter(property="localRepository",
             required=true,
             readonly=true)
  protected ArtifactRepository localRepository

  Local Repository.

• remoteRepositories

  @Parameter(property="project.remoteArtifactRepositories")
  protected List<ArtifactRepository> remoteRepositories

  Remote repositories used for the project.

  Since:

  2.1

• settings

  @Parameter(defaultValue="${settings}",
             readonly=true,
             required=true)
  protected Settings settings

  The current user system settings for use in Maven.

  Since:

  2.3

• customBundle

  @Parameter(defaultValue="${project.basedir}/src/site/custom/project-info-report.properties")
  protected String customBundle

  Path for a custom bundle instead of using the default one.
  Using this field, you could change the texts in the generated reports.

  Since:

  2.3

• skipEmptyReport

  @Parameter(defaultValue="true")
  protected boolean skipEmptyReport

  Skip the project info report generation if a report-specific section of the POM is empty. Defaults to true.

  Since:

  2.8

Constructor Detail

• AbstractProjectInfoReport

  public AbstractProjectInfoReport()

Method Detail

• canGenerateReport

  public boolean canGenerateReport()

  Specified by:

  canGenerateReport in interface MavenReport

  Overrides:

  canGenerateReport in class AbstractMavenReport

• execute

  public void execute()
               throws MojoExecutionException

  Specified by:

  execute in interface Mojo

  Overrides:

  execute in class AbstractMavenReport

  Throws:

  MojoExecutionException

• getCategoryName

  public String getCategoryName()

  Specified by:

  getCategoryName in interface MavenReport

  Overrides:

  getCategoryName in class AbstractMavenReport

• isEmpty

  protected boolean isEmpty(Collection<?> coll)

  Parameters:

  coll - The collection to be checked.

  Returns:

  true if coll is empty false otherwise.

• getOutputDirectory

  protected String getOutputDirectory()

  Overrides:

  getOutputDirectory in class AbstractMavenReport

• getReportOutputDirectory

  public File getReportOutputDirectory()

  Specified by:

  getReportOutputDirectory in interface MavenReport

  Overrides:

  getReportOutputDirectory in class AbstractMavenReport

• setReportOutputDirectory

  public void setReportOutputDirectory(File reportOutputDirectory)

  Specified by:

  setReportOutputDirectory in interface MavenReport

  Overrides:

  setReportOutputDirectory in class AbstractMavenReport

• getProject

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

  Overrides:

  getProject in class AbstractMavenReport

• getPlugin

  protected Plugin getPlugin(String pluginId)

  Parameters:

  pluginId - The id of the plugin

  Returns:

  The information about the plugin.

• getPluginParameter

  protected String getPluginParameter(String pluginId,
                          String param)

  Parameters:

  pluginId - The pluginId

  param - The child which should be checked.

  Returns:

  The value of the dom tree.

• getSiteRenderer

  protected Renderer getSiteRenderer()

  Overrides:

  getSiteRenderer in class AbstractMavenReport

• getI18nString

  protected String getI18nString(Locale locale,
                     String key)

  Parameters:

  locale - The locale

  key - The key to search for

  Returns:

  The text appropriate for the locale.

• getI18N

  protected org.codehaus.plexus.i18n.I18N getI18N(Locale locale)

  Parameters:

  locale - The local.

  Returns:

  I18N for the locale

• getI18Nsection

  protected abstract String getI18Nsection()

  Returns:

  The according string for the section.

• getName

  public String getName(Locale locale)

• getDescription

  public String getDescription(Locale locale)