MavenMultiPageReportpublic interface MavenReport
| Modifier and Type | Field | Description |
|---|---|---|
static java.lang.String |
CATEGORY_PROJECT_INFORMATION |
Category for project information reports
|
static java.lang.String |
CATEGORY_PROJECT_REPORTS |
Category for project reports
|
static java.lang.String |
ROLE |
Plexus lookup name
|
| Modifier and Type | Method | Description |
|---|---|---|
boolean |
canGenerateReport() |
Verify some conditions before generate the report.
|
void |
generate(org.codehaus.doxia.sink.Sink sink,
java.util.Locale locale) |
Generate the report depending the wanted locale.
|
java.lang.String |
getCategoryName() |
Get the category name for this report.
|
java.lang.String |
getDescription(java.util.Locale locale) |
Get the localized report description.
|
java.lang.String |
getName(java.util.Locale locale) |
Get the localized report name.
|
java.lang.String |
getOutputName() |
Get the base name used to create report's output file(s).
|
java.io.File |
getReportOutputDirectory() |
|
boolean |
isExternalReport() |
An external report is a report which calls a third party program which generates some reports too.
|
void |
setReportOutputDirectory(java.io.File outputDirectory) |
Set a new output directory.
|
static final java.lang.String ROLE
static final java.lang.String CATEGORY_PROJECT_INFORMATION
static final java.lang.String CATEGORY_PROJECT_REPORTS
void generate(org.codehaus.doxia.sink.Sink sink,
java.util.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 anyjava.lang.String getOutputName()
java.lang.String getCategoryName()
CATEGORY_PROJECT_INFORMATION
or CATEGORY_PROJECT_REPORTSjava.lang.String getName(java.util.Locale locale)
locale - the wanted locale to return the report's name, could be null.java.lang.String getDescription(java.util.Locale locale)
locale - the wanted locale to return the report's description, could be null.void setReportOutputDirectory(java.io.File outputDirectory)
outputDirectory - the new output directoryjava.io.File getReportOutputDirectory()
boolean isExternalReport()
boolean canGenerateReport()