org.apache.maven.plugins.site
Class SiteMojo

java.lang.Object
  extended by org.apache.maven.plugin.AbstractMojo
      extended by org.apache.maven.plugins.site.AbstractSiteMojo
          extended by org.apache.maven.plugins.site.AbstractSiteRenderingMojo
              extended by org.apache.maven.plugins.site.SiteMojo
All Implemented Interfaces:
ContextEnabled, Mojo, org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable
Direct Known Subclasses:
SiteJarMojo

@Mojo(name="site",
      requiresDependencyResolution=TEST,
      requiresReports=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.

Version:
$Id: SiteMojo.html 861484 2013-05-09 23:10:16Z hboutemy $
Author:
Emmanuel Venisse, Vincent Siveton

Field Summary
protected  File outputDirectory
          Directory where the project sites and report distributions will be generated.
 
Fields inherited from class org.apache.maven.plugins.site.AbstractSiteRenderingMojo
generatedSiteDirectory, mavenSession, reports, siteRenderer
 
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
SiteMojo()
           
 
Method Summary
 void execute()
           Generate the project site

throws MojoExecutionException if any

 
Methods inherited from class org.apache.maven.plugins.site.AbstractSiteRenderingMojo
categoriseReports, contextualize, createSiteRenderingContext, getReports, locateDocuments, locateReports, populateReportItems
 
Methods inherited from class org.apache.maven.plugins.site.AbstractSiteMojo
getInputEncoding, getMavenVersion, getOutputEncoding, isMaven3OrMore
 
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 Detail

outputDirectory

@Parameter(property="siteOutputDirectory",
           defaultValue="${project.reporting.outputDirectory}")
protected File outputDirectory
Directory where the project sites and report distributions will be generated.

Constructor Detail

SiteMojo

public SiteMojo()
Method Detail

execute

public void execute()
             throws MojoExecutionException,
                    MojoFailureException
Generate the project site

throws MojoExecutionException if any

Throws:
MojoExecutionException
MojoFailureException
See Also:
Mojo.execute()


Copyright © 2002-2013 The Apache Software Foundation. All Rights Reserved.