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 Details

    • 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 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 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

      private String append(String url, String path)