AbstractMavenReportTest (Apache Maven Reporting Implementation 2.3 Test 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.reporting.AbstractMavenReportTest

All Implemented Interfaces:

ContextEnabled, Mojo, MavenMultiPageReport, MavenReport
```
@Mojo(name="test")
public class AbstractMavenReportTest
extends AbstractMavenReport
```
Typical code to copy as a reporting plugin start: choose the goal name, then implement getOutputName(), getName( Locale ), getDescription( Locale ) and of course executeReport( Locale ).

Field Summary
- 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

AbstractMavenReportTest()

Method Summary

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

Methods inherited from class org.apache.maven.reporting.AbstractMavenReport
canGenerateReport, closeReport, execute, generate, generate, generate, getCategoryName, getInputEncoding, getOutputDirectory, getOutputEncoding, getProject, getReportOutputDirectory, getSink, getSinkFactory, getSiteRenderer, 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

Constructor Detail
- AbstractMavenReportTest
```
public AbstractMavenReportTest()
```

Method Detail

getOutputName
```
public String getOutputName()
```

getName
```
public String getName(Locale locale)
```

getDescription

public String getDescription(Locale locale)

executeReport

protected void executeReport(Locale locale)
                      throws MavenReportException

Specified by:: executeReport in class AbstractMavenReport
Throws:: MavenReportException

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2002–2014 The Apache Software Foundation. All rights reserved.