DependencyInformationReport (Apache Maven Project Info Reports Plugin 2.8.1 API)

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:

ContextEnabled, Mojo, MavenMultiPageReport, MavenReport
```
@Mojo(name="dependency-info")
public final class DependencyInformationReport
extends AbstractProjectInfoReport
```
Generates code snippets to be added to build tools.

Since:

2.5

Version:

$Id: DependencyInformationReport.html 964673 2015-09-07 20:28:21Z hboutemy $

Author:

Simone Tripodi

- Field Summary
  
  Fields
  Modifier and Type Field and Description
  
  protected String artifactId
  
  protected String groupId
  
  protected String packaging
  
  protected String version
  - Fields inherited from class org.apache.maven.report.projectinfo.AbstractProjectInfoReport
    customBundle, factory, localRepository, mavenProjectBuilder, outputDirectory, project, remoteRepositories, resolver, settings, siteRenderer, siteTool, skipEmptyReport
  - 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
  
  DependencyInformationReport()
- Method Summary
  
  Methods
  Modifier and Type Method and Description
  
  protected void executeReport(Locale locale)
  
  protected String getI18Nsection()
  
  String getOutputName()
  - Methods inherited from class org.apache.maven.report.projectinfo.AbstractProjectInfoReport
    canGenerateReport, execute, getCategoryName, getDescription, getI18N, getI18nString, getName, getOutputDirectory, getPlugin, getPluginParameter, getProject, getReportOutputDirectory, getSiteRenderer, isEmpty, setReportOutputDirectory
  - Methods inherited from class org.apache.maven.reporting.AbstractMavenReport
    closeReport, 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

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

Constructors
Constructor and Description
`DependencyInformationReport()`

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

Field Detail

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 Detail
- DependencyInformationReport
```
public DependencyInformationReport()
```

Method Detail
- 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 MavenReportException
```
  Specified by:
  
  executeReport in class AbstractMavenReport
  
  Throws:
  
  MavenReportException

Class DependencyInformationReport

Field Summary

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

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

Fields inherited from interface org.apache.maven.plugin.Mojo

Constructor Summary

Method Summary

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

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

Methods inherited from class org.apache.maven.plugin.AbstractMojo

Methods inherited from class java.lang.Object

Field Detail

groupId

artifactId

version

packaging

Constructor Detail

DependencyInformationReport

Method Detail

getOutputName

getI18Nsection

executeReport