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
Abstract class to compute effective site model for site descriptors.
- Since:
- 3.5
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate org.apache.maven.doxia.site.inheritance.SiteModelInheritanceAssembler
The component for assembling site model inheritance.protected List
<org.apache.maven.project.MavenProject> The reactor projects.private boolean
Make links in the site descriptor relative to the project URL.protected List
<org.eclipse.aether.repository.RemoteRepository> Remote project repositories used for the project.protected org.eclipse.aether.RepositorySystemSession
protected File
Directory containing thesite.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 -
Method Summary
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 Details
-
assembler
@Component private org.apache.maven.doxia.site.inheritance.SiteModelInheritanceAssembler assemblerThe component for assembling site model inheritance. -
reactorProjects
@Parameter(defaultValue="${reactorProjects}", required=true, readonly=true) protected List<org.apache.maven.project.MavenProject> reactorProjectsThe 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> remoteProjectRepositoriesRemote 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
Directory containing thesite.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
-
relativizeSiteLinks
@Parameter(property="relativizeSiteLinks", defaultValue="true") private boolean relativizeSiteLinksMake links in the site descriptor relative to the project URL. By default, any absolute links that appear in the site descriptor, e.g. banner hrefs, breadcrumbs, menu links, etc., will be made relative to project.url. Links will not be changed if this is set to false, or if the project has no URL defined.- Since:
- 2.3
-
-
Constructor Details
-
AbstractSiteDescriptorMojo
public AbstractSiteDescriptorMojo()
-
-
Method Details
-
prepareSiteModel
protected org.apache.maven.doxia.site.SiteModel prepareSiteModel(Locale locale) throws org.apache.maven.plugin.MojoExecutionException - Throws:
org.apache.maven.plugin.MojoExecutionException
-
append
-