org.apache.maven.plugin.plugin

Class PluginReport

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.reporting.AbstractMavenReport

org.apache.maven.plugin.plugin.PluginReport

All Implemented Interfaces:

ContextEnabled, Mojo, MavenMultiPageReport, MavenReport

@Mojo(name="report",
      threadSafe=true)
 @Execute(phase=PROCESS_CLASSES)
public class PluginReport
extends AbstractMavenReport

Generates the Plugin's documentation report: plugin-info.html plugin overview page, and one goal-mojo.html per goal.

Since:

2.0

Author:

Stephane Nicoll, Vincent Siveton

Field Summary

Fields

Modifier and Type	Field and Description
protected Set<Artifact>	dependencies The set of dependencies for the current project
protected String	goalPrefix The goal prefix that will appear before the ":".
protected ArtifactRepository	local Location of the local repository.
protected MojoScanner	mojoScanner Mojo scanner tools.
protected List<ArtifactRepository>	remoteRepos List of Remote Repositories used by the resolver

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 and Description
PluginReport()

Method Summary

Modifier and Type	Method and Description
boolean	canGenerateReport()
protected void	executeReport(Locale locale)
protected static ResourceBundle	getBundle(Locale locale)
String	getDescription(Locale locale)
String	getName(Locale locale)
protected String	getOutputDirectory()
String	getOutputName()
protected MavenProject	getProject()
protected Renderer	getSiteRenderer()

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

closeReport, execute, generate, generate, generate, getCategoryName, getInputEncoding, getOutputEncoding, getReportOutputDirectory, getSink, getSinkFactory, isExternalReport, 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

Field Detail

mojoScanner

@Component
protected MojoScanner mojoScanner

Mojo scanner tools.

goalPrefix

@Parameter(property="goalPrefix")
protected String goalPrefix

The goal prefix that will appear before the ":". By default, this plugin applies a heuristic to derive a heuristic from the plugin's artifactId.

It removes any occurrences of the regular expression -?maven-?, and then removes any occurrences of -?plugin-?.

For example, horsefeature-maven-plugin becomes horsefeature.

(There is a special case for maven-plugin-plugin: it is mapped to 'plugin')

Since:

2.4

dependencies

@Parameter(defaultValue="${project.artifacts}",
           required=true,
           readonly=true)
protected Set<Artifact> dependencies

The set of dependencies for the current project

Since:

3.0

remoteRepos

@Parameter(defaultValue="${project.remoteArtifactRepositories}",
           required=true,
           readonly=true)
protected List<ArtifactRepository> remoteRepos

List of Remote Repositories used by the resolver

Since:

3.0

local

@Parameter(defaultValue="${localRepository}",
           required=true,
           readonly=true)
protected ArtifactRepository local

Location of the local repository.

Since:

3.0

Constructor Detail

PluginReport

public PluginReport()

Method Detail

getSiteRenderer

protected Renderer getSiteRenderer()

Overrides:

getSiteRenderer in class AbstractMavenReport

getOutputDirectory

protected String getOutputDirectory()

Overrides:

getOutputDirectory in class AbstractMavenReport

getProject

protected MavenProject getProject()

Overrides:

getProject in class AbstractMavenReport

canGenerateReport

public boolean canGenerateReport()

Specified by:

canGenerateReport in interface MavenReport

Overrides:

canGenerateReport in class AbstractMavenReport

executeReport

protected void executeReport(Locale locale)
                      throws MavenReportException

Specified by:

executeReport in class AbstractMavenReport

Throws:

MavenReportException

getDescription

public String getDescription(Locale locale)

getName

public String getName(Locale locale)

getOutputName

public String getOutputName()

getBundle

protected static ResourceBundle getBundle(Locale locale)

Parameters:

locale - not null

Returns:

the bundle for this report