Class SiteMojo
- java.lang.Object
-
- org.apache.maven.plugin.AbstractMojo
-
- org.apache.maven.plugins.site.AbstractSiteMojo
-
- org.apache.maven.plugins.site.descriptor.AbstractSiteDescriptorMojo
-
- org.apache.maven.plugins.site.render.AbstractSiteRenderingMojo
-
- org.apache.maven.plugins.site.render.SiteMojo
-
- All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled
,org.apache.maven.plugin.Mojo
- Direct Known Subclasses:
SiteJarMojo
@Mojo(name="site", requiresDependencyResolution=TEST, requiresReports=true, threadSafe=true) public class SiteMojo extends AbstractSiteRenderingMojo
Generates the site for a single project.Note that links between module sites in a multi module build will not work, since local build directory structure doesn't match deployed site.
-
-
Field Summary
Fields Modifier and Type Field Description private boolean
generateReports
Convenience parameter that allows you to disable report generation.protected java.io.File
outputDirectory
Directory where the project sites and report distributions will be generated (as html/css/...).private boolean
validate
Whether to validate xml input documents.-
Fields inherited from class org.apache.maven.plugins.site.render.AbstractSiteRenderingMojo
generatedSiteDirectory, mavenReportExecutor, mavenSession, mojoExecution, outputTimestamp, siteRenderer
-
Fields inherited from class org.apache.maven.plugins.site.descriptor.AbstractSiteDescriptorMojo
reactorProjects, remoteProjectRepositories, repoSession, siteDirectory
-
Fields inherited from class org.apache.maven.plugins.site.AbstractSiteMojo
i18n, project, siteTool, skip
-
-
Constructor Summary
Constructors Constructor Description SiteMojo()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
execute()
private java.io.File
getOutputDirectory(java.util.Locale locale)
org.apache.maven.project.MavenProject
getProject()
org.apache.maven.execution.MavenSession
getSession()
private java.util.List<org.apache.maven.doxia.siterenderer.DocumentRenderer>
renderDoxiaDocuments(java.util.Collection<org.apache.maven.doxia.siterenderer.DocumentRenderer> documents, org.apache.maven.doxia.siterenderer.SiteRenderingContext context, java.io.File outputDirectory)
Render Doxia documents from the list given, but not reports.private void
renderLocale(java.util.Locale locale, java.util.List<org.apache.maven.reporting.exec.MavenReportExecution> reports, java.util.List<java.util.Locale> supportedLocales, java.io.File outputDirectory)
private void
renderNonDoxiaDocuments(java.util.Collection<org.apache.maven.doxia.siterenderer.DocumentRenderer> documents, org.apache.maven.doxia.siterenderer.SiteRenderingContext context, java.io.File outputDirectory)
Render non-Doxia documents (e.g., reports) from the list given-
Methods inherited from class org.apache.maven.plugins.site.render.AbstractSiteRenderingMojo
categoriseReports, checkInputEncoding, createSiteRenderingContext, getInputEncoding, getOutputEncoding, getReports, locateDocuments, locateReports, populateReportItems
-
Methods inherited from class org.apache.maven.plugins.site.descriptor.AbstractSiteDescriptorMojo
prepareSiteModel
-
Methods inherited from class org.apache.maven.plugins.site.AbstractSiteMojo
getLocales
-
-
-
-
Field Detail
-
outputDirectory
@Parameter(property="siteOutputDirectory", defaultValue="${project.reporting.outputDirectory}") protected java.io.File outputDirectory
Directory where the project sites and report distributions will be generated (as html/css/...).
-
generateReports
@Parameter(property="generateReports", defaultValue="true") private boolean generateReports
Convenience parameter that allows you to disable report generation.
-
validate
@Parameter(property="validate", defaultValue="false") private boolean validate
Whether to validate xml input documents. If set to true, all input documents in xml format (in particular xdoc and fml) will be validated and any error will lead to a build failure.- Since:
- 2.1.1
-
-
Method Detail
-
execute
public void execute() throws org.apache.maven.plugin.MojoExecutionException, org.apache.maven.plugin.MojoFailureException
- Throws:
org.apache.maven.plugin.MojoExecutionException
org.apache.maven.plugin.MojoFailureException
-
renderLocale
private void renderLocale(java.util.Locale locale, java.util.List<org.apache.maven.reporting.exec.MavenReportExecution> reports, java.util.List<java.util.Locale> supportedLocales, java.io.File outputDirectory) throws java.io.IOException, org.apache.maven.doxia.siterenderer.RendererException, org.apache.maven.plugin.MojoFailureException, org.apache.maven.plugin.MojoExecutionException
- Throws:
java.io.IOException
org.apache.maven.doxia.siterenderer.RendererException
org.apache.maven.plugin.MojoFailureException
org.apache.maven.plugin.MojoExecutionException
-
renderDoxiaDocuments
private java.util.List<org.apache.maven.doxia.siterenderer.DocumentRenderer> renderDoxiaDocuments(java.util.Collection<org.apache.maven.doxia.siterenderer.DocumentRenderer> documents, org.apache.maven.doxia.siterenderer.SiteRenderingContext context, java.io.File outputDirectory) throws org.apache.maven.doxia.siterenderer.RendererException, java.io.IOException
Render Doxia documents from the list given, but not reports.- Parameters:
documents
- a collection of documents containing both Doxia source files and reports- Returns:
- the sublist of documents that are not Doxia source files
- Throws:
org.apache.maven.doxia.siterenderer.RendererException
java.io.IOException
-
renderNonDoxiaDocuments
private void renderNonDoxiaDocuments(java.util.Collection<org.apache.maven.doxia.siterenderer.DocumentRenderer> documents, org.apache.maven.doxia.siterenderer.SiteRenderingContext context, java.io.File outputDirectory) throws org.apache.maven.doxia.siterenderer.RendererException, java.io.IOException
Render non-Doxia documents (e.g., reports) from the list given- Parameters:
documents
- a collection of documents containing non-Doxia source files- Throws:
org.apache.maven.doxia.siterenderer.RendererException
java.io.IOException
-
getOutputDirectory
private java.io.File getOutputDirectory(java.util.Locale locale)
-
getProject
public org.apache.maven.project.MavenProject getProject()
-
getSession
public org.apache.maven.execution.MavenSession getSession()
-
-