org.apache.maven.reporting
Interface MavenReport


public interface MavenReport

The basis for a Maven report.

Since:
2.0
Version:
$Id: MavenReport.java 640549 2008-03-24 20:05:11Z bentmann $
Author:
Brett Porter, Emmanuel Venisse, Vincent Siveton

Field Summary
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
 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)
           
 String getName(Locale locale)
           
 String getOutputName()
           
 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.codehaus.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, could be null.
Throws:
MavenReportException - if any

getOutputName

String getOutputName()
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 CATEGORY_PROJECT_INFORMATION CATEGORY_PROJECT_REPORTS

getName

String getName(Locale locale)
Parameters:
locale - the wanted locale to return the report's name, could be null.
Returns:
the name of this report.

getDescription

String getDescription(Locale locale)
Parameters:
locale - the wanted locale to return the report's description, could be null.
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 false.

canGenerateReport

boolean canGenerateReport()
Verify some conditions before generate the report.

Returns:
true if this report could be generated, false otherwise. Default should true.


Copyright © 2001-2009 The Apache Software Foundation. All Rights Reserved.