org.apache.maven.plugins.site
Class AbstractSiteMojo

java.lang.Object
  extended by org.apache.maven.plugin.AbstractMojo
      extended by org.apache.maven.plugins.site.AbstractSiteMojo
All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo
Direct Known Subclasses:
AbstractDeployMojo, AbstractSiteRenderingMojo, SiteDescriptorAttachMojo

public abstract class AbstractSiteMojo
extends org.apache.maven.plugin.AbstractMojo

Base class for site mojos.

Author:
Brett Porter

Field Summary
protected  org.codehaus.plexus.i18n.I18N i18n
          Internationalization.
protected  String locales
          A comma separated list of locales supported by Maven.
protected  org.apache.maven.artifact.repository.ArtifactRepository localRepository
          The local repository.
protected  org.apache.maven.project.MavenProject project
          The maven project.
protected  List<org.apache.maven.project.MavenProject> reactorProjects
          The reactor projects.
protected  File siteDirectory
          Directory containing the site.xml file and the source for apt, fml and xdoc docs.
protected  org.apache.maven.doxia.tools.SiteTool siteTool
          SiteTool.
 
Fields inherited from interface org.apache.maven.plugin.Mojo
ROLE
 
Constructor Summary
AbstractSiteMojo()
           
 
Method Summary
protected  void checkMavenVersion()
          Check the current Maven version and emit a warning if it's Maven 3.
protected  String getInputEncoding()
          Gets the input files encoding.
protected  String getMavenVersion()
           
protected  String getOutputEncoding()
          Gets the effective reporting output files encoding.
 
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
 
Methods inherited from interface org.apache.maven.plugin.Mojo
execute
 

Field Detail

locales

protected String locales
A comma separated list of locales supported by Maven. The first valid token will be the default Locale for this instance of the Java Virtual Machine.

Is defined by:
expression:
${locales}

siteTool

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

Is a Plexus component defined by:

i18n

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

Is a Plexus component defined by:

siteDirectory

protected File siteDirectory
Directory containing the site.xml file and the source for apt, fml and xdoc docs.

Is defined by:
default-value:
${basedir}/src/site

project

protected org.apache.maven.project.MavenProject project
The maven project.

Is defined by:
default-value:
${project}
Is readonly.
Is required.

localRepository

protected org.apache.maven.artifact.repository.ArtifactRepository localRepository
The local repository.

Is defined by:
default-value:
${localRepository}
Is readonly.

reactorProjects

protected List<org.apache.maven.project.MavenProject> reactorProjects
The reactor projects.

Is defined by:
default-value:
${reactorProjects}
Is readonly.
Is required.
Constructor Detail

AbstractSiteMojo

public AbstractSiteMojo()
Method Detail

getInputEncoding

protected String getInputEncoding()
Gets the input files encoding.

Returns:
The input files encoding, never null.

getOutputEncoding

protected String getOutputEncoding()
Gets the effective reporting output files encoding.

Returns:
The effective reporting output file encoding, never null.

checkMavenVersion

protected void checkMavenVersion()
Check the current Maven version and emit a warning if it's Maven 3. This plugin does not work with Maven 3.x.


getMavenVersion

protected String getMavenVersion()
                          throws IOException
Throws:
IOException


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