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 decoration model for site descriptors.

Since:

3.5

Field Summary

Fields

Modifier and Type	Field and Description
private org.apache.maven.doxia.site.decoration.inheritance.DecorationModelInheritanceAssembler	assembler The component for assembling site decoration model inheritance.
private boolean	relativizeDecorationLinks Make links in the site descriptor relative to the project URL.
protected java.util.List<org.apache.maven.artifact.repository.ArtifactRepository>	repositories Remote repositories used for the project.
protected java.io.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, localRepository, project, reactorProjects, 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
private java.lang.String	append(java.lang.String url, java.lang.String path)
protected org.apache.maven.doxia.site.decoration.DecorationModel	prepareDecorationModel(java.util.Locale locale)

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

getLocales, getMavenVersion, isMaven3OrMore

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

assembler

@Component
private org.apache.maven.doxia.site.decoration.inheritance.DecorationModelInheritanceAssembler assembler

The component for assembling site decoration model inheritance.

repositories

@Parameter(defaultValue="${project.remoteArtifactRepositories}",
           readonly=true)
protected java.util.List<org.apache.maven.artifact.repository.ArtifactRepository> repositories

Remote repositories used for the project.

siteDirectory

@Parameter(defaultValue="${basedir}/src/site")
protected java.io.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

relativizeDecorationLinks

@Parameter(property="relativizeDecorationLinks",
           defaultValue="true")
private boolean relativizeDecorationLinks

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

Constructor Detail

AbstractSiteDescriptorMojo

public AbstractSiteDescriptorMojo()

Method Detail

prepareDecorationModel

protected org.apache.maven.doxia.site.decoration.DecorationModel prepareDecorationModel(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)