|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.maven.plugin.AbstractMojo
org.apache.maven.plugins.site.AbstractSiteMojo
org.apache.maven.plugins.site.AbstractSiteRenderingMojo
public abstract class AbstractSiteRenderingMojo
Base class for site rendering mojos.
Field Summary | |
---|---|
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 Map<Object,Object> |
attributes
The template properties for rendering the site. |
protected File |
generatedSiteDirectory
Directory containing generated documentation. |
protected Map<String,String> |
moduleExcludes
Module type exclusion mappings ex: fml -> **/*-m1.fml (excludes fml files ending in '-m1.fml' recursively)
The configuration looks like this: |
protected List<org.apache.maven.reporting.MavenReport> |
reports
|
protected List<org.apache.maven.artifact.repository.ArtifactRepository> |
repositories
Remote repositories used for the project. |
protected org.apache.maven.doxia.siterenderer.Renderer |
siteRenderer
Site renderer. |
Fields inherited from class org.apache.maven.plugins.site.AbstractSiteMojo |
---|
i18n, locales, localRepository, project, reactorProjects, siteDirectory, siteTool |
Fields inherited from interface org.apache.maven.plugin.Mojo |
---|
ROLE |
Constructor Summary | |
---|---|
AbstractSiteRenderingMojo()
|
Method Summary | |
---|---|
protected Map<String,List<org.apache.maven.reporting.MavenReport>> |
categoriseReports(Collection<org.apache.maven.reporting.MavenReport> 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(Locale locale)
|
protected List<org.apache.maven.reporting.MavenReport> |
filterReports(List<org.apache.maven.reporting.MavenReport> reports)
|
protected Map<String,org.apache.maven.doxia.siterenderer.DocumentRenderer> |
locateDocuments(org.apache.maven.doxia.siterenderer.SiteRenderingContext context,
List<org.apache.maven.reporting.MavenReport> reports,
Locale locale)
|
protected Map<String,org.apache.maven.reporting.MavenReport> |
locateReports(List<org.apache.maven.reporting.MavenReport> reports,
Map<String,org.apache.maven.doxia.siterenderer.DocumentRenderer> documents,
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 |
Methods inherited from class org.apache.maven.plugins.site.AbstractSiteMojo |
---|
getInputEncoding, getOutputEncoding, populateReportItems, toRelative |
Methods inherited from class org.apache.maven.plugin.AbstractMojo |
---|
getLog, getPluginContext, setLog, setPluginContext |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.apache.maven.plugin.Mojo |
---|
execute |
Field Detail |
---|
protected Map<String,String> 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 List<org.apache.maven.artifact.repository.ArtifactRepository> repositories
protected org.apache.maven.artifact.factory.ArtifactFactory artifactFactory
protected Map<Object,Object> attributes
protected org.apache.maven.doxia.siterenderer.Renderer siteRenderer
protected List<org.apache.maven.reporting.MavenReport> reports
protected File generatedSiteDirectory
Constructor Detail |
---|
public AbstractSiteRenderingMojo()
Method Detail |
---|
protected List<org.apache.maven.reporting.MavenReport> filterReports(List<org.apache.maven.reporting.MavenReport> reports)
protected org.apache.maven.doxia.siterenderer.SiteRenderingContext createSiteRenderingContext(Locale locale) throws org.apache.maven.plugin.MojoExecutionException, IOException, org.apache.maven.plugin.MojoFailureException
org.apache.maven.plugin.MojoExecutionException
IOException
org.apache.maven.plugin.MojoFailureException
protected Map<String,org.apache.maven.reporting.MavenReport> locateReports(List<org.apache.maven.reporting.MavenReport> reports, Map<String,org.apache.maven.doxia.siterenderer.DocumentRenderer> documents, Locale locale)
reports
- A List of MavenReportsdocuments
- A Map of documents, keyed by filenamelocale
- the Locale the reports are processed for.
protected Map<String,List<org.apache.maven.reporting.MavenReport>> categoriseReports(Collection<org.apache.maven.reporting.MavenReport> reports)
reports
- A Collection of MavenReports
protected Map<String,org.apache.maven.doxia.siterenderer.DocumentRenderer> locateDocuments(org.apache.maven.doxia.siterenderer.SiteRenderingContext context, List<org.apache.maven.reporting.MavenReport> reports, Locale locale) throws IOException, org.apache.maven.doxia.siterenderer.RendererException
IOException
org.apache.maven.doxia.siterenderer.RendererException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |