Index

C

canGenerateReport() - Method in interface org.apache.maven.reporting.MavenReport: Verify some conditions before generating the report, for example that there is something to report on.
CATEGORY_PROJECT_INFORMATION - Static variable in interface org.apache.maven.reporting.MavenReport: Category for project information reports
CATEGORY_PROJECT_REPORTS - Static variable in interface org.apache.maven.reporting.MavenReport: Category for project reports

generate(Sink, Locale) - Method in interface org.apache.maven.reporting.MavenReport: Generate the report for the given locale.
generate(Sink, SinkFactory, Locale) - Method in interface org.apache.maven.reporting.MavenMultiPageReport: Deprecated.

Generate multi page report.
generate(Sink, SinkFactory, Locale) - Method in interface org.apache.maven.reporting.MavenReport: Generate the report for the given locale, possibly as several pages.
getCategoryName() - Method in interface org.apache.maven.reporting.MavenReport: Get the category name for this report.
getDescription(Locale) - Method in interface org.apache.maven.reporting.MavenReport: Get the localized report description.
getName(Locale) - Method in interface org.apache.maven.reporting.MavenReport: Get the localized report name.
getOutputName() - Method in interface org.apache.maven.reporting.MavenReport: Deprecated.
Method name does not properly reflect its purpose. Implement and use MavenReport.getOutputPath() instead.
getOutputPath() - Method in interface org.apache.maven.reporting.MavenReport: Get the path relative to MavenReport.getReportOutputDirectory() where the report's main output file will be written.
getReportOutputDirectory() - Method in interface org.apache.maven.reporting.MavenReport: Get the shared report output directory.
getTitle() - Method in interface org.apache.maven.reporting.MavenReportRenderer: Get the report's title.

isExternalReport() - Method in interface org.apache.maven.reporting.MavenReport: Tell whether this report writes its own output files instead of rendering into the sink, as the Javadoc report does when it calls the javadoc tool.

MavenMultiPageReport - Interface in org.apache.maven.reporting: Deprecated.
MavenReport.generate(Sink, SinkFactory, Locale) now exists as a default method, so implement MavenReport directly.
MavenReport - Interface in org.apache.maven.reporting: The basis for a Maven report: a report that the Maven Site Plugin renders into the project site.
MavenReportException - Exception in org.apache.maven.reporting: An exception occurring during the execution of a Maven report.
MavenReportException(String) - Constructor for exception org.apache.maven.reporting.MavenReportException: Create an exception with a message.
MavenReportException(String, Exception) - Constructor for exception org.apache.maven.reporting.MavenReportException: Create an exception with a message and a cause.
MavenReportRenderer - Interface in org.apache.maven.reporting: Renders the content of a report.

org.apache.maven.reporting - package org.apache.maven.reporting: The API between the Maven Site Plugin and the reports it renders.

render() - Method in interface org.apache.maven.reporting.MavenReportRenderer: Render the report.
ROLE - Static variable in interface org.apache.maven.reporting.MavenReport: Plexus lookup name

serialVersionUID - Static variable in exception org.apache.maven.reporting.MavenReportException: The serialVersionUID
setReportOutputDirectory(File) - Method in interface org.apache.maven.reporting.MavenReport: Set a new shared report output directory.