AbstractSiteMojo (Maven Site Plugin 3 3.3 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.maven.plugins.site
Class AbstractSiteMojo

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

All Implemented Interfaces:: ContextEnabled, Mojo

Direct Known Subclasses:: AbstractDeployMojo, AbstractSiteRenderingMojo, SiteDescriptorAttachMojo

public abstract class AbstractSiteMojo
extends AbstractMojo
extends AbstractMojo

Base class for site mojos.

Author:: Brett Porter

Field Summary
`protected I18N`	`i18n` Internationalization.
`protected String`	`locales` A comma separated list of locales supported by Maven.
`protected ArtifactRepository`	`localRepository` The local repository.
`protected MavenProject`	`project` The maven project.
`protected List<MavenProject>`	`reactorProjects` The reactor projects.
`protected File`	`siteDirectory` Directory containing the site.xml file and the source for apt, fml and xdoc docs.
`protected SiteTool`	`siteTool` SiteTool.

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

Constructor Summary
`AbstractSiteMojo()`

Method Summary
`protected String`	`getInputEncoding()` Gets the input files encoding.
`protected static String`	`getMavenVersion()`
`protected String`	`getOutputEncoding()` Gets the effective reporting output files encoding.
`protected static boolean`	`isMaven3OrMore()` Check the current Maven version to see if it's Maven 3.0 or newer.

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

locales

@Parameter(property="locales")
protected String locales

A comma separated list of locales supported by Maven. The first valid token will be the default Locale for this instance of the Java Virtual Machine.

siteTool

@Component
protected SiteTool siteTool

SiteTool.

i18n

@Component
protected I18N i18n

Internationalization.

siteDirectory

@Parameter(defaultValue="${basedir}/src/site")
protected File siteDirectory

Directory containing the site.xml file and the source for apt, fml and xdoc docs.

project

@Component
protected MavenProject project

The maven project.

localRepository

@Parameter(defaultValue="${localRepository}",
           readonly=true)
protected ArtifactRepository localRepository

The local repository.

reactorProjects

@Parameter(defaultValue="${reactorProjects}",
           required=true,
           readonly=true)
protected List<MavenProject> reactorProjects

The reactor projects.

Constructor Detail

AbstractSiteMojo

public AbstractSiteMojo()

Method Detail

getInputEncoding

protected String getInputEncoding()

Gets the input files encoding.

Returns:: The input files encoding, never null.

getOutputEncoding

protected String getOutputEncoding()

Gets the effective reporting output files encoding.

Returns:: The effective reporting output file encoding, never null.

isMaven3OrMore

protected static boolean isMaven3OrMore()

Check the current Maven version to see if it's Maven 3.0 or newer.

getMavenVersion

protected static String getMavenVersion()