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 Description private org.apache.maven.doxia.site.inheritance.SiteModelInheritanceAssembler
assembler
The component for assembling site model inheritance.protected java.util.List<org.apache.maven.project.MavenProject>
reactorProjects
The reactor projects.private boolean
relativizeSiteLinks
Make links in the site descriptor relative to the project URL.protected java.util.List<org.eclipse.aether.repository.RemoteRepository>
remoteProjectRepositories
Remote project repositories used for the project.protected org.eclipse.aether.RepositorySystemSession
repoSession
protected java.io.File
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).-
Fields inherited from class org.apache.maven.plugins.site.AbstractSiteMojo
i18n, project, siteTool, skip
-
-
Constructor Summary
Constructors Constructor Description AbstractSiteDescriptorMojo()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description private java.lang.String
append(java.lang.String url, java.lang.String path)
protected org.apache.maven.doxia.site.SiteModel
prepareSiteModel(java.util.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
-
-
-
-
Field Detail
-
assembler
@Component private org.apache.maven.doxia.site.inheritance.SiteModelInheritanceAssembler assembler
The component for assembling site model inheritance.
-
reactorProjects
@Parameter(defaultValue="${reactorProjects}", required=true, readonly=true) protected java.util.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 java.util.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 java.io.File 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 relativizeSiteLinks
Make 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
-
-
Method Detail
-
prepareSiteModel
protected org.apache.maven.doxia.site.SiteModel prepareSiteModel(java.util.Locale locale) throws org.apache.maven.plugin.MojoExecutionException
- Throws:
org.apache.maven.plugin.MojoExecutionException
-
append
private java.lang.String append(java.lang.String url, java.lang.String path)
-
-