org.apache.maven.reporting
Interface MavenReport

public interface MavenReport

The basis for a Maven report.

Version:

$Id: MavenReport.java 163376 2005-02-23 00:06:06Z brett $

Author:

Brett Porter, Emmanuel Venisse

Field Summary

static String	CATEGORY_PROJECT_INFORMATION
static String	CATEGORY_PROJECT_REPORTS
static String	ROLE

Method Summary

boolean	canGenerateReport()
void	generate(org.codehaus.doxia.sink.Sink sink, Locale locale)
String	getCategoryName()
String	getDescription(Locale locale)
String	getName(Locale locale)
String	getOutputName()
File	getReportOutputDirectory()
boolean	isExternalReport()
void	setReportOutputDirectory(File outputDirectory)

Field Detail

ROLE

public static final String ROLE

CATEGORY_PROJECT_INFORMATION

public static final String CATEGORY_PROJECT_INFORMATION

See Also:

Constant Field Values

CATEGORY_PROJECT_REPORTS

public static final String CATEGORY_PROJECT_REPORTS

See Also:

Constant Field Values

Method Detail

generate

public void generate(org.codehaus.doxia.sink.Sink sink,
                     Locale locale)
              throws MavenReportException

Throws:

MavenReportException

getOutputName

public String getOutputName()

getName

public String getName(Locale locale)

getCategoryName

public String getCategoryName()

getDescription

public String getDescription(Locale locale)

setReportOutputDirectory

public void setReportOutputDirectory(File outputDirectory)

getReportOutputDirectory

public File getReportOutputDirectory()

isExternalReport

public boolean isExternalReport()

canGenerateReport

public boolean canGenerateReport()