AbstractSiteDescriptorMojo (Apache Maven Site Plugin 3.5.1 API)

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- org.apache.maven.plugin.AbstractMojo
- - org.apache.maven.plugins.site.AbstractSiteMojo
  - - org.apache.maven.plugins.site.descriptor.AbstractSiteDescriptorMojo

All Implemented Interfaces:

ContextEnabled, 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
`protected List<ArtifactRepository>`	`repositories` Remote repositories used for the project.
`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, localRepository, project, reactorProjects, siteTool, skip

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

Constructor Summary

Constructors
Constructor and Description

AbstractSiteDescriptorMojo()

Method Summary

Methods
Modifier and Type Method and Description

protected DecorationModel prepareDecorationModel(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
- repositories
```
@Parameter(defaultValue="${project.remoteArtifactRepositories}",
           readonly=true)
protected List<ArtifactRepository> repositories
```
  Remote repositories used for the project.
- 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

prepareDecorationModel

protected DecorationModel prepareDecorationModel(Locale locale)
                                          throws MojoExecutionException

Throws:: MojoExecutionException

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2002–2016 The Apache Software Foundation. All rights reserved.