org.apache.maven.reporting

Interface MavenReport

All Known Subinterfaces:

MavenMultiPageReport

public interface MavenReport

The basis for a Maven report.

Since:

2.0

Author:

Brett Porter, Emmanuel Venisse, Vincent Siveton

Field Summary

Fields

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

Method Summary

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.

Field Detail

ROLE

static final String ROLE

Plexus lookup name

CATEGORY_PROJECT_INFORMATION

static final String CATEGORY_PROJECT_INFORMATION

Category for project information reports

See Also:

Constant Field Values

CATEGORY_PROJECT_REPORTS

static final String CATEGORY_PROJECT_REPORTS

Category for project reports

See Also:

Constant Field Values

Method Detail

generate

void generate(org.apache.maven.doxia.sink.Sink sink,
              Locale locale)
       throws MavenReportException

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.

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 or CATEGORY_PROJECT_REPORTS

getName

String getName(Locale locale)

Get the localized report name.

Parameters:

locale - the wanted locale to return the report's name.

Returns:

the name of this report.

getDescription

String getDescription(Locale locale)

Get the localized report description.

Parameters:

locale - the wanted locale to return the report's description.

Returns:

the description of this report.

setReportOutputDirectory

void setReportOutputDirectory(File outputDirectory)

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 be false.

canGenerateReport

boolean canGenerateReport()
                   throws MavenReportException

Verify some conditions before generating the report.

Returns:

true if this report can be generated, false otherwise. Default should be true.

Throws:

MavenReportException - if any