Index
All Classes and Interfaces|All Packages
A
- AbstractMavenReport - Class in org.apache.maven.reporting
-
The basis for a Maven report which can be generated both as part of a site generation or as a direct standalone goal invocation.
- AbstractMavenReport() - Constructor for class org.apache.maven.reporting.AbstractMavenReport
- AbstractMavenReportRenderer - Class in org.apache.maven.reporting
-
An abstract class to manage report generation, with many helper methods to ease the job: you just need to implement getTitle() and renderBody().
- AbstractMavenReportRenderer(Sink) - Constructor for class org.apache.maven.reporting.AbstractMavenReportRenderer
-
Default constructor.
C
- canGenerateReport() - Method in class org.apache.maven.reporting.AbstractMavenReport
- closeReport() - Method in class org.apache.maven.reporting.AbstractMavenReport
-
Actions when closing the report.
- constructXrefLocation(File, boolean) - Method in class org.apache.maven.reporting.AbstractMavenReport
-
Contructs the (Test) Source XRef location relative to the
AbstractMavenReport.getReportOutputDirectory()
withAbstractMavenReport.getXrefLocation(File, boolean)
. - createLinkPatternedText(String, String) - Static method in class org.apache.maven.reporting.AbstractMavenReportRenderer
-
Create a link pattern text defined by
{text, url}
.
E
- endSection() - Method in class org.apache.maven.reporting.AbstractMavenReportRenderer
-
Convenience method to wrap section ending in the current sink.
- endTable() - Method in class org.apache.maven.reporting.AbstractMavenReportRenderer
-
Convenience method to wrap the table ending in the current sink.
- execute() - Method in class org.apache.maven.reporting.AbstractMavenReport
-
This method is called when the report generation is invoked directly as a standalone Mojo.
- executeReport(Locale) - Method in class org.apache.maven.reporting.AbstractMavenReport
-
Execute the generation of the report.
G
- generate(Sink, Locale) - Method in class org.apache.maven.reporting.AbstractMavenReport
-
Deprecated.
- generate(Sink, SinkFactory, Locale) - Method in class org.apache.maven.reporting.AbstractMavenReport
-
This method is called when the report generation is invoked by maven-site-plugin.
- getCategoryName() - Method in class org.apache.maven.reporting.AbstractMavenReport
- getInputEncoding() - Method in class org.apache.maven.reporting.AbstractMavenReport
-
Gets the input files encoding.
- getLocale() - Method in class org.apache.maven.reporting.AbstractMavenReport
-
Gets the locale
- getOutputDirectory() - Method in class org.apache.maven.reporting.AbstractMavenReport
- getOutputEncoding() - Method in class org.apache.maven.reporting.AbstractMavenReport
-
Gets the effective reporting output files encoding.
- getProject() - Method in class org.apache.maven.reporting.AbstractMavenReport
- getReportOutputDirectory() - Method in class org.apache.maven.reporting.AbstractMavenReport
- getSink() - Method in class org.apache.maven.reporting.AbstractMavenReport
- getSinkFactory() - Method in class org.apache.maven.reporting.AbstractMavenReport
- getSiteRenderer() - Method in class org.apache.maven.reporting.AbstractMavenReport
- getTitle() - Method in class org.apache.maven.reporting.AbstractMavenReportRenderer
- getXrefLocation(File, boolean) - Method in class org.apache.maven.reporting.AbstractMavenReport
-
Returns the (Test) Source XRef location as passthrough if provided, otherwise returns the default value.
I
- isExternalReport() - Method in class org.apache.maven.reporting.AbstractMavenReport
J
- javaScript(String) - Method in class org.apache.maven.reporting.AbstractMavenReportRenderer
-
Convenience method to add a Javascript code in the current sink.
L
- link(String, String) - Method in class org.apache.maven.reporting.AbstractMavenReportRenderer
-
Convenience method to wrap a link in the current sink.
- linkPatternedText(String) - Method in class org.apache.maven.reporting.AbstractMavenReportRenderer
-
Convenience method to wrap a patterned text in the current link.
- locale - Variable in class org.apache.maven.reporting.AbstractMavenReport
-
The locale to use when the report generation is invoked directly as a standalone Mojo.
M
- mojoExecution - Variable in class org.apache.maven.reporting.AbstractMavenReport
-
The mojo execution
O
- org.apache.maven.reporting - package org.apache.maven.reporting
- outputDirectory - Variable in class org.apache.maven.reporting.AbstractMavenReport
-
The shared output directory for the report.
- outputFormat - Variable in class org.apache.maven.reporting.AbstractMavenReport
-
The report output format: null by default, to represent a site, but can be configured to a Doxia Sink id.
- outputTimestamp - Variable in class org.apache.maven.reporting.AbstractMavenReport
-
Timestamp for reproducible output archive entries, either formatted as ISO 8601
yyyy-MM-dd'T'HH:mm:ssXXX
or as an int representing seconds since the epoch (like SOURCE_DATE_EPOCH).
P
- paragraph(String) - Method in class org.apache.maven.reporting.AbstractMavenReportRenderer
-
Convenience method to wrap a paragraph in the current sink.
- project - Variable in class org.apache.maven.reporting.AbstractMavenReport
-
The Maven Project.
- propertiesToString(Properties) - Static method in class org.apache.maven.reporting.AbstractMavenReportRenderer
-
Convenience method to display a
Properties
object as comma separated String.
R
- reactorProjects - Variable in class org.apache.maven.reporting.AbstractMavenReport
-
The reactor projects.
- remoteProjectRepositories - Variable in class org.apache.maven.reporting.AbstractMavenReport
-
Remote project repositories used for the project.
- render() - Method in class org.apache.maven.reporting.AbstractMavenReportRenderer
- renderBody() - Method in class org.apache.maven.reporting.AbstractMavenReportRenderer
-
Renderer the body content of the report.
- repoSession - Variable in class org.apache.maven.reporting.AbstractMavenReport
-
The repository system session.
S
- setReportOutputDirectory(File) - Method in class org.apache.maven.reporting.AbstractMavenReport
- sink - Variable in class org.apache.maven.reporting.AbstractMavenReportRenderer
-
The current sink to use
- siteDirectory - Variable in class org.apache.maven.reporting.AbstractMavenReport
-
Directory containing the
site.xml
file. - siteRenderer - Variable in class org.apache.maven.reporting.AbstractMavenReport
-
Doxia Site Renderer component.
- siteTool - Variable in class org.apache.maven.reporting.AbstractMavenReport
-
SiteTool.
- startSection(String) - Method in class org.apache.maven.reporting.AbstractMavenReportRenderer
-
Convenience method to wrap section creation in the current sink.
- startSection(String, String) - Method in class org.apache.maven.reporting.AbstractMavenReportRenderer
-
Convenience method to wrap section creation in the current sink.
- startTable() - Method in class org.apache.maven.reporting.AbstractMavenReportRenderer
-
Convenience method to wrap the table start in the current sink.
- startTable(int[], boolean) - Method in class org.apache.maven.reporting.AbstractMavenReportRenderer
-
Convenience method to wrap the table start in the current sink.
T
- tableCaption(String) - Method in class org.apache.maven.reporting.AbstractMavenReportRenderer
-
Convenience method to wrap a table caption in the current sink.
- tableCell(String) - Method in class org.apache.maven.reporting.AbstractMavenReportRenderer
-
Convenience method to wrap a table cell start in the current sink.
- tableCell(String, boolean) - Method in class org.apache.maven.reporting.AbstractMavenReportRenderer
-
Convenience method to wrap a table cell start in the current sink.
- tableHeader(String[]) - Method in class org.apache.maven.reporting.AbstractMavenReportRenderer
-
Convenience method to wrap a table header row start in the current sink.
- tableHeaderCell(String) - Method in class org.apache.maven.reporting.AbstractMavenReportRenderer
-
Convenience method to wrap the table header cell start in the current sink.
- tableRow(String[]) - Method in class org.apache.maven.reporting.AbstractMavenReportRenderer
-
Convenience method to wrap a table row start in the current sink.
- text(String) - Method in class org.apache.maven.reporting.AbstractMavenReportRenderer
-
Convenience method to wrap a text in the current sink.
V
- verbatimLink(String, String) - Method in class org.apache.maven.reporting.AbstractMavenReportRenderer
-
Convenience method to wrap a text with a given link href as verbatim style in the current sink.
- verbatimSource(String) - Method in class org.apache.maven.reporting.AbstractMavenReportRenderer
-
Convenience method to wrap source code as verbatim style in the current sink .
- verbatimText(String) - Method in class org.apache.maven.reporting.AbstractMavenReportRenderer
-
Convenience method to wrap a text as verbatim style in the current sink .
All Classes and Interfaces|All Packages
AbstractMavenReport.generate(Sink, SinkFactory, Locale)
instead.