|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.maven.plugin.AbstractMojo
org.apache.maven.plugins.site.AbstractSiteMojo
public abstract class AbstractSiteMojo
Base class for site mojos.
Field Summary | |
---|---|
protected org.codehaus.plexus.i18n.I18N |
i18n
Internationalization. |
protected java.lang.String |
inputEncoding
Specifies the input encoding. |
protected org.apache.maven.artifact.repository.ArtifactRepository |
localRepository
The local repository. |
protected org.apache.maven.project.MavenProjectBuilder |
mavenProjectBuilder
Project builder |
protected java.lang.String |
outputEncoding
Specifies the output encoding. |
protected org.apache.maven.project.MavenProject |
project
The maven project. |
protected java.util.List |
reactorProjects
The reactor projects. |
protected java.io.File |
siteDirectory
Directory containing the site.xml file and the source for apt, fml and xdoc docs. |
Fields inherited from interface org.apache.maven.plugin.Mojo |
---|
ROLE |
Constructor Summary | |
---|---|
AbstractSiteMojo()
|
Method Summary | |
---|---|
protected java.util.List |
getAvailableLocales()
Init the localesList variable. |
protected java.lang.String |
getInterpolatedSiteDescriptorContent(java.util.Map props,
org.apache.maven.project.MavenProject aProject,
java.lang.String siteDescriptorContent)
Interpolating several expressions in the site descriptor content. |
protected org.apache.maven.project.MavenProject |
getParentProject(org.apache.maven.project.MavenProject aProject)
Returns the parent POM URL. |
protected java.lang.String |
getRelativePath(java.lang.String to,
java.lang.String from)
|
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 void |
populateModules(org.apache.maven.doxia.site.decoration.DecorationModel decorationModel,
java.util.Locale locale,
boolean keepInheritedRefs)
|
protected void |
populateProjectParentMenu(org.apache.maven.doxia.site.decoration.DecorationModel decorationModel,
java.util.Locale locale,
org.apache.maven.project.MavenProject parentProject,
boolean keepInheritedRefs)
|
protected void |
populateReportItems(org.apache.maven.doxia.site.decoration.DecorationModel decorationModel,
java.util.Locale locale,
java.util.Map reportsByOutputName)
|
protected void |
populateReportsMenu(org.apache.maven.doxia.site.decoration.DecorationModel decorationModel,
java.util.Locale locale,
java.util.Map categories)
|
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 |
---|
protected org.codehaus.plexus.i18n.I18N i18n
protected java.io.File siteDirectory
protected org.apache.maven.project.MavenProject project
protected org.apache.maven.artifact.repository.ArtifactRepository localRepository
protected java.util.List reactorProjects
protected org.apache.maven.project.MavenProjectBuilder mavenProjectBuilder
protected java.lang.String inputEncoding
protected java.lang.String outputEncoding
Constructor Detail |
---|
public AbstractSiteMojo()
Method Detail |
---|
protected java.util.List getAvailableLocales()
localesList
variable.
If locales
variable is available, the first valid token will be the defaultLocale
for this instance of the Java Virtual Machine.
Locale
protected java.io.File getSiteDescriptorFile(java.io.File basedir, java.util.Locale locale)
basedir
- the base dirlocale
- the locale
protected void populateModules(org.apache.maven.doxia.site.decoration.DecorationModel decorationModel, java.util.Locale locale, boolean keepInheritedRefs) throws org.apache.maven.plugin.MojoExecutionException
org.apache.maven.plugin.MojoExecutionException
protected void populateReportsMenu(org.apache.maven.doxia.site.decoration.DecorationModel decorationModel, java.util.Locale locale, java.util.Map categories)
protected void populateReportItems(org.apache.maven.doxia.site.decoration.DecorationModel decorationModel, java.util.Locale locale, java.util.Map reportsByOutputName)
protected java.lang.String getRelativePath(java.lang.String to, java.lang.String from)
protected void populateProjectParentMenu(org.apache.maven.doxia.site.decoration.DecorationModel decorationModel, java.util.Locale locale, org.apache.maven.project.MavenProject parentProject, boolean keepInheritedRefs)
protected org.apache.maven.project.MavenProject getParentProject(org.apache.maven.project.MavenProject aProject)
aProject
-
protected java.lang.String getInterpolatedSiteDescriptorContent(java.util.Map props, org.apache.maven.project.MavenProject aProject, java.lang.String siteDescriptorContent) throws java.io.IOException
encoding
.
For instance:
<project>
<name>myProjectName</name>
</project>
<properties>
<my.value>hello</my.value>
</properties>
props
- aProject
- siteDescriptorContent
-
java.io.IOException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |