Package org.apache.maven.report.projectinfo

Class DependencyInformationReport

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.reporting.AbstractMavenReport

org.apache.maven.report.projectinfo.AbstractProjectInfoReport

org.apache.maven.report.projectinfo.DependencyInformationReport

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenMultiPageReport, org.apache.maven.reporting.MavenReport

@Mojo(name="dependency-info")
public final class DependencyInformationReport
extends AbstractProjectInfoReport

Generates code snippets of the Maven coordinates to be added to build tools.

Since:

2.5

Author:

Simone Tripodi

Field Summary

Fields

Modifier and Type	Field	Description
protected String	artifactId
protected String	groupId
protected String	packaging
protected String	version

Fields inherited from class org.apache.maven.report.projectinfo.AbstractProjectInfoReport

customBundle, pluginRepositories, projectBuilder, remoteRepositories, settings, skipEmptyReport

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

locale, mojoExecution, outputDirectory, outputFormat, outputTimestamp, project, reactorProjects, 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
DependencyInformationReport(org.apache.maven.repository.RepositorySystem repositorySystem, org.codehaus.plexus.i18n.I18N i18n, org.apache.maven.project.ProjectBuilder projectBuilder)

Method Summary

Modifier and Type	Method	Description
protected void	executeReport(Locale locale)
protected String	getI18Nsection()
String	getOutputName()

Methods inherited from class org.apache.maven.report.projectinfo.AbstractProjectInfoReport

canGenerateReport, getCategoryName, getDescription, getI18N, getI18nString, getLicenseMappings, getMojoExecution, getName, getPlugin, getPluginParameter, getReactorProjects, getSession, isEmpty

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

closeReport, constructXrefLocation, execute, generate, generate, getInputEncoding, getLocale, getOutputDirectory, getOutputEncoding, getProject, getReportOutputDirectory, getSink, getSinkFactory, getSiteRenderer, getXrefLocation, 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

Methods inherited from interface org.apache.maven.reporting.MavenReport

getOutputPath

Field Details

groupId

@Parameter(defaultValue="${project.groupId}",
           required=true)
protected String groupId

artifactId

@Parameter(defaultValue="${project.artifactId}",
           required=true)
protected String artifactId

version

@Parameter(defaultValue="${project.version}",
           required=true)
protected String version

packaging

@Parameter(defaultValue="${project.packaging}",
           required=true)
protected String packaging

Constructor Details

DependencyInformationReport

@Inject
public DependencyInformationReport(org.apache.maven.repository.RepositorySystem repositorySystem,
 org.codehaus.plexus.i18n.I18N i18n,
 org.apache.maven.project.ProjectBuilder projectBuilder)

Method Details

getOutputName

public String getOutputName()

getI18Nsection

protected String getI18Nsection()

Specified by:

getI18Nsection in class AbstractProjectInfoReport

Returns:

The according string for the section.

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