org.apache.maven.plugins.site.descriptor

Class AbstractSiteDescriptorMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.plugins.site.AbstractSiteMojo

org.apache.maven.plugins.site.descriptor.AbstractSiteDescriptorMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

Direct Known Subclasses:

AbstractSiteRenderingMojo, EffectiveSiteMojo, SiteDescriptorAttachMojo

public abstract class AbstractSiteDescriptorMojo
extends AbstractSiteMojo

Abstract class to compute effective site model for site descriptors.

Since:

3.5

Field Summary

Fields

Modifier and Type	Field and Description
protected List<org.apache.maven.project.MavenProject>	reactorProjects The reactor projects.
protected List<org.eclipse.aether.repository.RemoteRepository>	remoteProjectRepositories Remote project repositories used for the project.
protected org.eclipse.aether.RepositorySystemSession	repoSession
protected File	siteDirectory Directory containing the site.xml file and the source for hand written docs (one directory per Doxia-source-supported markup types): see Doxia Markup Languages References).

Fields inherited from class org.apache.maven.plugins.site.AbstractSiteMojo

i18n, project, siteTool, skip

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractSiteDescriptorMojo()

Method Summary

Modifier and Type	Method and Description
protected org.apache.maven.doxia.site.SiteModel	prepareSiteModel(Locale locale)

Methods inherited from class org.apache.maven.plugins.site.AbstractSiteMojo

getLocales

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

reactorProjects

@Parameter(defaultValue="${reactorProjects}",
           required=true,
           readonly=true)
protected List<org.apache.maven.project.MavenProject> reactorProjects

The reactor projects.

repoSession

@Parameter(defaultValue="${repositorySystemSession}",
           required=true,
           readonly=true)
protected org.eclipse.aether.RepositorySystemSession repoSession

remoteProjectRepositories

@Parameter(defaultValue="${project.remoteProjectRepositories}",
           readonly=true)
protected List<org.eclipse.aether.repository.RemoteRepository> remoteProjectRepositories

Remote project repositories used for the project. todo this is used for site descriptor resolution - it should relate to the actual project but for some reason they are not always filled in

siteDirectory

@Parameter(defaultValue="${basedir}/src/site")
protected File siteDirectory

Directory containing the site.xml file and the source for hand written docs (one directory per Doxia-source-supported markup types): see Doxia Markup Languages References).

Since:

2.3

Constructor Detail

AbstractSiteDescriptorMojo

public AbstractSiteDescriptorMojo()

Method Detail

prepareSiteModel

protected org.apache.maven.doxia.site.SiteModel prepareSiteModel(Locale locale)
                                                          throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException