Class AbstractSiteMojo

java.lang.Object
org.apache.maven.plugin.AbstractMojo
org.apache.maven.plugins.site.AbstractSiteMojo
All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo
Direct Known Subclasses:
AbstractDeployMojo, AbstractSiteDescriptorMojo
public abstract class AbstractSiteMojo extends org.apache.maven.plugin.AbstractMojo
Base class for site mojos.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected org.codehaus.plexus.i18n.I18N
    i18n
    Internationalization.
    private String
    locales
    A comma separated list of locales to render.
    protected org.apache.maven.project.MavenProject
    project
    The Maven project.
    protected org.apache.maven.doxia.tools.SiteTool
    siteTool
    SiteTool.
    protected boolean
    skip
    Set this to 'true' to skip site generation and staging.

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

    ROLE

  • Constructor Summary

    Constructors
    Constructor
    Description
    AbstractSiteMojo()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected List<Locale>
    getLocales()
     

    Methods inherited from class org.apache.maven.plugin.AbstractMojo

    getLog, getPluginContext, setLog, setPluginContext

    Methods inherited from class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

    execute

  • Field Details

    • locales

      @Parameter(property="locales", defaultValue="default") private String locales
      A comma separated list of locales to render. The first valid token will be the default Locale for this site.
      Since:
      2.3

    • skip

      @Parameter(property="maven.site.skip", defaultValue="false") protected boolean skip
      Set this to 'true' to skip site generation and staging.
      Since:
      3.0

    • siteTool

      @Component protected org.apache.maven.doxia.tools.SiteTool siteTool
      SiteTool.

    • i18n

      @Component protected org.codehaus.plexus.i18n.I18N i18n
      Internationalization.

    • project

      @Parameter(defaultValue="${project}", readonly=true) protected org.apache.maven.project.MavenProject project
      The Maven project.

  • Constructor Details

    • AbstractSiteMojo

      public AbstractSiteMojo()

  • Method Details

    • getLocales

      protected List<Locale> getLocales()