public interface MavenReport
Modifier and Type | Field and Description |
---|---|
static String |
CATEGORY_PROJECT_INFORMATION
Category for project information reports
|
static String |
CATEGORY_PROJECT_REPORTS
Category for project reports
|
static String |
ROLE
Plexus lookup name
|
Modifier and Type | Method and Description |
---|---|
boolean |
canGenerateReport()
Verify some conditions before generating the report.
|
void |
generate(org.apache.maven.doxia.sink.Sink sink,
Locale locale)
Generate the report depending the wanted locale.
|
String |
getCategoryName()
Get the category name for this report.
|
String |
getDescription(Locale locale)
Get the localized report description.
|
String |
getName(Locale locale)
Get the localized report name.
|
String |
getOutputName()
Get the base name used to create report's output file(s).
|
File |
getReportOutputDirectory() |
boolean |
isExternalReport()
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.
|
static final String ROLE
static final String CATEGORY_PROJECT_INFORMATION
static final String CATEGORY_PROJECT_REPORTS
void generate(org.apache.maven.doxia.sink.Sink sink, Locale locale) throws MavenReportException
sink
- the sink to use for the generation.locale
- the wanted locale to generate the report.MavenReportException
- if anyString getOutputName()
String getCategoryName()
CATEGORY_PROJECT_INFORMATION
or CATEGORY_PROJECT_REPORTS
String getName(Locale locale)
locale
- the wanted locale to return the report's name.String getDescription(Locale locale)
locale
- the wanted locale to return the report's description.void setReportOutputDirectory(File outputDirectory)
outputDirectory
- the new output directoryFile getReportOutputDirectory()
boolean isExternalReport()
true
if this report is external, false
otherwise.
Default should be false
.boolean canGenerateReport() throws MavenReportException
true
if this report can be generated, false
otherwise.
Default should be true
.MavenReportException
- if anyCopyright © 2002–2023 The Apache Software Foundation. All rights reserved.