ModulesReport (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.ModulesReport

All Implemented Interfaces:

ContextEnabled, Mojo, MavenMultiPageReport, MavenReport
```
@Mojo(name="modules")
public class ModulesReport
extends AbstractProjectInfoReport
```
Generates the Project Modules report.

Since:

2.2

Version:

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

Author:

ltheussl

- Field Summary
  - 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
  
  ModulesReport()
- Method Summary
  
  Methods
  Modifier and Type Method and Description
  
  boolean canGenerateReport()
  
  void executeReport(Locale locale)
  
  protected String getI18Nsection()
  
  String getOutputName()
  - Methods inherited from class org.apache.maven.report.projectinfo.AbstractProjectInfoReport
    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

Constructors
Constructor and Description
`ModulesReport()`

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

- Constructor Detail
  - ModulesReport
```
public ModulesReport()
```
- Method Detail
  - canGenerateReport
```
public boolean canGenerateReport()
```
    Specified by:
    
    canGenerateReport in interface MavenReport
    
    Overrides:
    
    canGenerateReport in class AbstractProjectInfoReport
  - executeReport
```
public void executeReport(Locale locale)
```
    Specified by:
    
    executeReport in class AbstractMavenReport
  - getOutputName
```
public String getOutputName()
```
  - getI18Nsection
```
protected String getI18Nsection()
```
    Specified by:
    
    getI18Nsection in class AbstractProjectInfoReport
    
    Returns:
    The according string for the section.

Class ModulesReport

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

Constructor Detail

ModulesReport

Method Detail

canGenerateReport

executeReport

getOutputName

getI18Nsection