Package org.apache.maven.plugins.site.render

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 multimodule build will not work, since local build directory structure doesn't match deployed site.

Author:

Emmanuel Venisse, Vincent Siveton

Field Summary

Fields

Modifier and Type	Field	Description
protected File	outputDirectory	Directory where the project sites and report distributions will be generated (as html/css/...).

Fields inherited from class org.apache.maven.plugins.site.render.AbstractSiteRenderingMojo

alternativeSiteSourceDirectories, 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

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor	Description
SiteMojo(org.apache.maven.doxia.site.inheritance.SiteModelInheritanceAssembler assembler, org.apache.maven.doxia.siterenderer.SiteRenderer siteRenderer, org.apache.maven.reporting.exec.MavenReportExecutor mavenReportExecutor)

Method Summary

Modifier and Type	Method	Description
void	execute()
org.apache.maven.project.MavenProject	getProject()
org.apache.maven.execution.MavenSession	getSession()

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

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

Field Details

outputDirectory

@Parameter(property="siteOutputDirectory",
           defaultValue="${project.reporting.outputDirectory}")
protected File outputDirectory

Directory where the project sites and report distributions will be generated (as html/css/...).

Constructor Details

SiteMojo

@Inject
public SiteMojo(org.apache.maven.doxia.site.inheritance.SiteModelInheritanceAssembler assembler,
 org.apache.maven.doxia.siterenderer.SiteRenderer siteRenderer,
 org.apache.maven.reporting.exec.MavenReportExecutor mavenReportExecutor)

Method Details

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

getProject

public org.apache.maven.project.MavenProject getProject()

getSession

public org.apache.maven.execution.MavenSession getSession()