Package org.apache.maven.reporting
Interface MavenReport
- All Known Subinterfaces:
MavenMultiPageReport
public interface MavenReport
The basis for a Maven report.
- Since:
- 2.0
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionboolean
Verify some conditions before generate the report.void
Generate the report depending the wanted locale.Get the category name for this report.getDescription
(Locale locale) Get the localized report description.Get the localized report name.Get the base name used to create report's output file(s).boolean
An external report is a report which calls a third party program which generates some reports too.void
setReportOutputDirectory
(File outputDirectory) Set a new output directory.
-
Field Details
-
ROLE
Plexus lookup name -
CATEGORY_PROJECT_INFORMATION
Category for project information reports- See Also:
-
CATEGORY_PROJECT_REPORTS
Category for project reports- See Also:
-
-
Method Details
-
generate
Generate the report depending the wanted locale.
Mainly used for external reports like javadoc.- Parameters:
sink
- the sink to use for the generation.locale
- the wanted locale to generate the report, could be null.- Throws:
MavenReportException
- if any
-
getOutputName
String getOutputName()Get the base name used to create report's output file(s).- Returns:
- the output name of this report.
-
getCategoryName
String getCategoryName()Get the category name for this report.- Returns:
- the category name of this report. Should be
CATEGORY_PROJECT_INFORMATION
orCATEGORY_PROJECT_REPORTS
-
getName
Get the localized report name.- Parameters:
locale
- the wanted locale to return the report's name, could be null.- Returns:
- the name of this report.
-
getDescription
Get the localized report description.- Parameters:
locale
- the wanted locale to return the report's description, could be null.- Returns:
- the description of this report.
-
setReportOutputDirectory
Set a new output directory. Useful for staging.- Parameters:
outputDirectory
- the new output directory
-
getReportOutputDirectory
File getReportOutputDirectory()- Returns:
- the current report output directory.
-
isExternalReport
boolean isExternalReport()An external report is a report which calls a third party program which generates some reports too. A good example is javadoc tool.- Returns:
true
if this report is external,false
otherwise. Default should befalse
.
-
canGenerateReport
boolean canGenerateReport()Verify some conditions before generate the report.- Returns:
true
if this report could be generated,false
otherwise. Default should betrue
.
-