ProjectIndexPageReport (Apache Maven Project Info Reports Plugin 2.8.1 API)

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- org.apache.maven.plugin.AbstractMojo
- - org.apache.maven.reporting.AbstractMavenReport
  - - org.apache.maven.report.projectinfo.AbstractProjectInfoReport
    - - org.apache.maven.report.projectinfo.ProjectIndexPageReport

All Implemented Interfaces:

ContextEnabled, Mojo, MavenMultiPageReport, MavenReport
```
@Mojo(name="index")
public class ProjectIndexPageReport
extends AbstractProjectInfoReport
```
Generates the project index page.

Since:

2.0

Version:

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

Author:

Brett Porter , Vincent Siveton

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

ProjectIndexPageReport()

Method Summary

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

Methods inherited from class org.apache.maven.report.projectinfo.AbstractProjectInfoReport
canGenerateReport, execute, getCategoryName, getI18N, getI18nString, 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

- Constructor Detail
  - ProjectIndexPageReport
```
public ProjectIndexPageReport()
```
- Method Detail
  - getName
```
public String getName(Locale locale)
```
    Description copied from class: AbstractProjectInfoReport
    
    Specified by:
    
    getName in interface MavenReport
    
    Overrides:
    
    getName in class AbstractProjectInfoReport
  - getDescription
```
public String getDescription(Locale locale)
```
    Description copied from class: AbstractProjectInfoReport
    
    Specified by:
    
    getDescription in interface MavenReport
    
    Overrides:
    
    getDescription 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.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2005–2015 The Apache Software Foundation. All rights reserved.