Package org.apache.maven.reporting

Interface MavenMultiPageReport

All Superinterfaces:

MavenReport

@Deprecated
public interface MavenMultiPageReport
extends MavenReport

Deprecated.

MavenReport.generate(Sink, SinkFactory, Locale) now exists as a default method, so implement MavenReport directly.

A report that renders several pages. Before 4.1.0 this interface was the only way for a report to receive a SinkFactory: adding an abstract method to MavenReport would have broken every existing report. Since 4.1.0, MavenReport declares MavenReport.generate(Sink, SinkFactory, Locale) as a default method.

Since:

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

Author:

Kenney Westerhof

See Also:

• MavenReport.generate(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	Description
void	generate(org.apache.maven.doxia.sink.Sink sink, org.apache.maven.doxia.sink.SinkFactory sinkFactory, Locale locale)	Deprecated. Generate multi page report.

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

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

Method Details

generate

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

Deprecated.

Generate multi page report.

Specified by:

generate in interface MavenReport

Parameters:

sink - The sink to write to.

sinkFactory - the sink factory to create sub sinks.

locale - The locale to use.

Throws:

MavenReportException - if an error occurs.