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 generate the report.
|
void |
generate(org.codehaus.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.codehaus.doxia.sink.Sink sink, Locale locale) throws MavenReportException
sink
- the sink to use for the generation.locale
- the wanted locale to generate the report, could be null.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, could be null.String getDescription(Locale locale)
locale
- the wanted locale to return the report's description, could be null.void setReportOutputDirectory(File outputDirectory)
outputDirectory
- the new output directoryFile getReportOutputDirectory()
boolean isExternalReport()
boolean canGenerateReport()
Copyright © 2002–2024 The Apache Software Foundation. All rights reserved.