org.apache.maven.plugins.site
public abstract class AbstractSiteRenderingMojo extends AbstractSiteMojo
Modifier and Type | Field and Description |
---|---|
protected org.apache.maven.artifact.factory.ArtifactFactory |
artifactFactory
The component used for creating artifact instances.
|
protected org.apache.maven.artifact.resolver.ArtifactResolver |
artifactResolver
The component that is used to resolve additional artifacts required.
|
protected org.apache.maven.doxia.site.decoration.inheritance.DecorationModelInheritanceAssembler |
assembler
The component for assembling inheritance.
|
protected java.util.Map |
attributes
The template properties for rendering the site.
|
protected java.io.File |
generatedSiteDirectory
Directory containing generated documentation.
|
protected java.util.Map |
moduleExcludes
Module type exclusion mappings
ex:
fml -> **/*-m1.fml (excludes fml files ending in '-m1.fml' recursively)
The configuration looks like this: |
protected java.util.List |
reports |
protected java.util.List |
repositories
Remote repositories used for the project.
|
protected org.apache.maven.doxia.siterenderer.Renderer |
siteRenderer
Site renderer.
|
i18n, locales, localRepository, project, reactorProjects, siteDirectory, siteTool
Constructor and Description |
---|
AbstractSiteRenderingMojo() |
Modifier and Type | Method and Description |
---|---|
protected java.util.Map |
categoriseReports(java.util.Collection reports)
Go through the collection of reports and put each report into a list for the appropriate category.
|
protected org.apache.maven.doxia.siterenderer.SiteRenderingContext |
createSiteRenderingContext(java.util.Locale locale) |
protected java.util.List |
filterReports(java.util.List reports) |
protected java.util.Map |
locateDocuments(org.apache.maven.doxia.siterenderer.SiteRenderingContext context,
java.util.List reports,
java.util.Locale locale) |
protected java.util.Map |
locateReports(java.util.List reports,
java.util.Map documents,
java.util.Locale locale)
Go through the list of reports and process each one like this:
Add the report to a map of reports keyed by filename having the report itself as value
If the report is not yet in the map of documents, add it together with a suitable renderer
|
getInputEncoding, getOutputEncoding, populateReportItems, toRelative
getLog, getPluginContext, setLog, setPluginContext
protected java.util.Map moduleExcludes
fml -> **/*-m1.fml
(excludes fml files ending in '-m1.fml' recursively)
The configuration looks like this:
<moduleExcludes> <moduleType>filename1.ext,**/*sample.ext</moduleType> <!-- moduleType can be one of 'apt', 'fml' or 'xdoc'. --> <!-- The value is a comma separated list of --> <!-- filenames or fileset patterns. --> <!-- Here's an example: --> <xdoc>changes.xml,navigation.xml</xdoc> </moduleExcludes>
protected org.apache.maven.doxia.site.decoration.inheritance.DecorationModelInheritanceAssembler assembler
protected org.apache.maven.artifact.resolver.ArtifactResolver artifactResolver
protected java.util.List repositories
protected org.apache.maven.artifact.factory.ArtifactFactory artifactFactory
protected java.util.Map attributes
protected org.apache.maven.doxia.siterenderer.Renderer siteRenderer
protected java.util.List reports
protected java.io.File generatedSiteDirectory
protected java.util.List filterReports(java.util.List reports)
protected org.apache.maven.doxia.siterenderer.SiteRenderingContext createSiteRenderingContext(java.util.Locale locale) throws org.apache.maven.plugin.MojoExecutionException, java.io.IOException, org.apache.maven.plugin.MojoFailureException
org.apache.maven.plugin.MojoExecutionException
java.io.IOException
org.apache.maven.plugin.MojoFailureException
protected java.util.Map locateReports(java.util.List reports, java.util.Map documents, java.util.Locale locale)
reports
- A List of MavenReportsdocuments
- A Map of documents, keyed by filenamelocale
- the Locale the reports are processed for.protected java.util.Map categoriseReports(java.util.Collection reports)
reports
- A Collection of MavenReportsprotected java.util.Map locateDocuments(org.apache.maven.doxia.siterenderer.SiteRenderingContext context, java.util.List reports, java.util.Locale locale) throws java.io.IOException, org.apache.maven.doxia.siterenderer.RendererException
java.io.IOException
org.apache.maven.doxia.siterenderer.RendererException
Copyright © 2014. All Rights Reserved.