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:
SiteDescriptorAttachMojo, SiteMojo

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

Base class for site mojos.

Version:
$Id: AbstractSiteMojo.java 358700 2005-12-23 04:40:48Z brett $
Author:
Brett Porter

Field Summary
protected  org.codehaus.plexus.i18n.I18N i18n
          Internationalization.
protected  java.io.File siteDirectory
          Directory containing source for apt, fml and xdoc docs.
 
Fields inherited from interface org.apache.maven.plugin.Mojo
ROLE
 
Constructor Summary
AbstractSiteMojo()
           
 
Method Summary
protected  java.io.File getSiteDescriptorFile(java.io.File basedir, java.util.Locale locale)
          Get the path of the site descriptor for a given locale.
protected  java.util.List initLocalesList()
          Init the localesList variable.
 
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

siteDirectory

protected java.io.File siteDirectory
Directory containing source for apt, fml and xdoc docs.


i18n

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

Constructor Detail

AbstractSiteMojo

public AbstractSiteMojo()
Method Detail

getSiteDescriptorFile

protected java.io.File getSiteDescriptorFile(java.io.File basedir,
                                             java.util.Locale locale)
Get the path of the site descriptor for a given locale.

Parameters:
locale - the locale
Returns:
the site descriptor path

initLocalesList

protected java.util.List initLocalesList()
Init the localesList variable.

If locales variable is available, the first valid token will be the defaultLocale for this instance of the Java Virtual Machine.

Returns:
a list of Locale


Copyright © {inceptionYear}-2010 Apache Software Foundation. All Rights Reserved.