org.apache.maven.report.projectinfo

Class AbstractProjectInfoReport

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.reporting.AbstractMavenReport

org.apache.maven.report.projectinfo.AbstractProjectInfoReport

All Implemented Interfaces:

ContextEnabled, Mojo, MavenMultiPageReport, MavenReport

Direct Known Subclasses:

CiManagementReport, DependenciesReport, DependencyConvergenceReport, DependencyInformationReport, DependencyManagementReport, DistributionManagementReport, IndexReport, IssueManagementReport, LicensesReport, MailingListsReport, ModulesReport, PluginManagementReport, PluginsReport, ScmReport, SummaryReport, TeamReport

public abstract class AbstractProjectInfoReport
extends AbstractMavenReport

Base class with the things that should be in AbstractMavenReport anyway.

Since:

2.0

Author:

Brett Porter

Field Summary

Fields

Modifier and Type	Field and Description
protected String	customBundle Path for a custom bundle instead of using the default one.
protected ArtifactRepository	localRepository Local Repository.
protected List<ArtifactRepository>	pluginRepositories Plugin repositories used for the project.
protected ProjectBuilder	projectBuilder
protected List<MavenProject>	reactorProjects The reactor projects.
protected List<ArtifactRepository>	remoteRepositories Remote repositories used for the project.
protected ArtifactResolver	resolver Artifact Resolver component.
protected Settings	settings The current user system settings for use in Maven.
protected SiteTool	siteTool SiteTool component.
protected boolean	skipEmptyReport Skip the project info report generation if a report-specific section of the POM is empty.

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

outputDirectory, project, siteRenderer

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
AbstractProjectInfoReport()

Method Summary

Modifier and Type	Method and Description
boolean	canGenerateReport()
void	execute()
String	getCategoryName()
String	getDescription(Locale locale)
protected org.codehaus.plexus.i18n.I18N	getI18N(Locale locale)
protected abstract String	getI18Nsection()
protected String	getI18nString(Locale locale, String key)
String	getName(Locale locale)
protected String	getOutputDirectory()
protected Plugin	getPlugin(String pluginId)
protected String	getPluginParameter(String pluginId, String param)
protected MavenProject	getProject()
protected List<MavenProject>	getReactorProjects() Reactor projects
File	getReportOutputDirectory()
protected MavenSession	getSession()
protected Renderer	getSiteRenderer()
protected boolean	isEmpty(Collection<?> coll)
void	setReportOutputDirectory(File reportOutputDirectory)

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

closeReport, executeReport, generate, generate, generate, getInputEncoding, getOutputEncoding, getSink, getSinkFactory, isExternalReport

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

getOutputName

Field Detail

siteTool

@Component
protected SiteTool siteTool

SiteTool component.

Since:

2.1

resolver

@Component
protected ArtifactResolver resolver

Artifact Resolver component.

projectBuilder

@Component
protected ProjectBuilder projectBuilder

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

pluginRepositories

@Parameter(property="project.pluginArtifactRepositories")
protected List<ArtifactRepository> pluginRepositories

Plugin repositories used for the project.

Since:

3.1.0

reactorProjects

@Parameter(defaultValue="${reactorProjects}",
           required=true,
           readonly=true)
protected List<MavenProject> reactorProjects

The reactor projects.

Since:

2.10

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-reports.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 MavenProject getProject()

Overrides:

getProject in class AbstractMavenReport

getSession

protected MavenSession getSession()

getReactorProjects

protected List<MavenProject> getReactorProjects()

Reactor projects

Returns:

List of projects

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)