org.apache.maven.reporting

Interface MavenMultiPageReport

All Superinterfaces:

MavenReport

public interface MavenMultiPageReport
extends MavenReport

Interface created separately for backwards compatibility. This method would ideally have been added in the MavenReport interface, and the other 'generate' method dropped. But that would have rendered all reporting mojo's uncompilable and binary incompatible.

Since:

3.0 (copied in maven-site-plugin 2.0-beta-6)

Author:

Kenney Westerhof

See Also:

MavenReport.generate(org.codehaus.doxia.sink.Sink, Locale)

Field Summary

Fields inherited from interface org.apache.maven.reporting.MavenReport

CATEGORY_PROJECT_INFORMATION, CATEGORY_PROJECT_REPORTS, ROLE

Method Summary

Modifier and Type	Method and Description
void	generate(Sink sink, SinkFactory sinkFactory, Locale locale) Generate multi page report.

Methods inherited from interface org.apache.maven.reporting.MavenReport

canGenerateReport, generate, getCategoryName, getDescription, getName, getOutputName, getReportOutputDirectory, isExternalReport, setReportOutputDirectory

Method Detail

generate

void generate(Sink sink,
              SinkFactory sinkFactory,
              Locale locale)
       throws MavenReportException

Generate multi page report.

Parameters:

sink - The sink to write to.

locale - The locale to use.

Throws:

MavenReportException - if an error occurs.