SiteRunMojo (Maven Site Plugin 3 3.3 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.maven.plugins.site
Class SiteRunMojo

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.apache.maven.plugins.site.AbstractSiteMojo
          org.apache.maven.plugins.site.AbstractSiteRenderingMojo
              org.apache.maven.plugins.site.SiteRunMojo

All Implemented Interfaces:: ContextEnabled, Mojo, org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable

@Mojo(name="run", aggregator=true, requiresReports=true) public class SiteRunMojo
extends AbstractSiteRenderingMojo
extends AbstractSiteRenderingMojo

Starts the site up, rendering documents as requested for faster editing. It uses Jetty as the web server.

Version:: $Id: SiteRunMojo.html 861484 2013-05-09 23:10:16Z hboutemy $
Author:: Brett Porter

Field Summary

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
`SiteRunMojo()`

Method Summary
`void`	`execute()`
`void`	`setPort(int port)`
`void`	`setTempWebappDirectory(File tempWebappDirectory)`

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`

Constructor Detail

SiteRunMojo

public SiteRunMojo()

Method Detail

execute

public void execute()
             throws MojoExecutionException,
                    MojoFailureException

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

setTempWebappDirectory

public void setTempWebappDirectory(File tempWebappDirectory)

setPort

public void setPort(int port)