org.apache.maven.plugins.site
Class SiteStageMojo

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
                  extended by org.apache.maven.plugins.site.SiteStageMojo
All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo
Direct Known Subclasses:
SiteStageDeployMojo

public class SiteStageMojo
extends SiteMojo

Staging a site in specific directory.

Useful to test the generated site.

Version:
$Id: SiteStageMojo.java 487567 2006-12-15 14:29:35Z jvanzyl $
Author:
Vincent Siveton

Field Summary
protected  java.io.File stagingDirectory
          Staging directory location.
 
Fields inherited from class org.apache.maven.plugins.site.SiteMojo
outputDirectory
 
Fields inherited from class org.apache.maven.plugins.site.AbstractSiteRenderingMojo
artifactFactory, artifactResolver, assembler, attributes, generatedSiteDirectory, moduleExcludes, reports, repositories, siteRenderer
 
Fields inherited from class org.apache.maven.plugins.site.AbstractSiteMojo
i18n, inputEncoding, localRepository, mavenProjectBuilder, outputEncoding, project, reactorProjects, siteDirectory
 
Fields inherited from interface org.apache.maven.plugin.Mojo
ROLE
 
Constructor Summary
SiteStageMojo()
           
 
Method Summary
 void execute()
          Generate the project site

throws MojoExecutionException if any

protected static java.lang.String getStructure(org.apache.maven.project.MavenProject project, boolean ignoreMissingSiteUrl)
          Generates the site structure using the project hiearchy (project and its modules) or using the distributionManagement elements from the pom.xml.
 
Methods inherited from class org.apache.maven.plugins.site.AbstractSiteRenderingMojo
categoriseReports, createSiteRenderingContext, filterReports, getDecorationModel, locateDocuments, locateReports
 
Methods inherited from class org.apache.maven.plugins.site.AbstractSiteMojo
getAvailableLocales, getInterpolatedSiteDescriptorContent, getParentProject, getRelativePath, getSiteDescriptorFile, populateModules, populateProjectParentMenu, populateReportItems, populateReportsMenu
 
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

stagingDirectory

protected java.io.File stagingDirectory
Staging directory location.

Constructor Detail

SiteStageMojo

public SiteStageMojo()
Method Detail

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException
Description copied from class: SiteMojo
Generate the project site

throws MojoExecutionException if any

Specified by:
execute in interface org.apache.maven.plugin.Mojo
Overrides:
execute in class SiteMojo
Throws:
org.apache.maven.plugin.MojoExecutionException
org.apache.maven.plugin.MojoFailureException
See Also:
Mojo.execute()

getStructure

protected static java.lang.String getStructure(org.apache.maven.project.MavenProject project,
                                               boolean ignoreMissingSiteUrl)
                                        throws org.apache.maven.plugin.MojoFailureException
Generates the site structure using the project hiearchy (project and its modules) or using the distributionManagement elements from the pom.xml.

Parameters:
project -
ignoreMissingSiteUrl -
Returns:
the structure relative path
Throws:
org.apache.maven.plugin.MojoFailureException - if any


Copyright © 2002-2011 Apache Software Foundation. All Rights Reserved.