A C D E F G I L M O P R S T

## A

AbstractSiteMojo - Class in org.apache.maven.plugins.site
  Base class for site mojos.
AbstractSiteMojo() - Constructor for class org.apache.maven.plugins.site.AbstractSiteMojo
AbstractSiteRenderingMojo - Class in org.apache.maven.plugins.site
  Base class for site rendering mojos.
AbstractSiteRenderingMojo() - Constructor for class org.apache.maven.plugins.site.AbstractSiteRenderingMojo
artifactFactory - Variable in class org.apache.maven.plugins.site.AbstractSiteRenderingMojo
  The component used for creating artifact instances.
artifactResolver - Variable in class org.apache.maven.plugins.site.AbstractSiteRenderingMojo
  The component that is used to resolve additional artifacts required.
assembler - Variable in class org.apache.maven.plugins.site.AbstractSiteRenderingMojo
  The component for assembling inheritance.
attributes - Variable in class org.apache.maven.plugins.site.AbstractSiteRenderingMojo
  The template properties for rendering the site.

## C

categoriseReports(Collection) - Method in class org.apache.maven.plugins.site.AbstractSiteRenderingMojo
  Go through the collection of reports and put each report into a list for the appropriate category.
CategorySummaryDocumentRenderer - Class in org.apache.maven.plugins.site
  Renders a Maven report.
CategorySummaryDocumentRenderer(RenderingContext, String, String, String, I18N, List) - Constructor for class org.apache.maven.plugins.site.CategorySummaryDocumentRenderer
CategorySummaryDocumentRenderer(RenderingContext, String, String, String, I18N, List, Log) - Constructor for class org.apache.maven.plugins.site.CategorySummaryDocumentRenderer
contextualize(Context) - Method in class org.apache.maven.plugins.site.SiteDeployMojo
contextualize(Context) - Method in class org.apache.maven.plugins.site.SiteStageDeployMojo
createSiteRenderingContext(Locale) - Method in class org.apache.maven.plugins.site.AbstractSiteRenderingMojo

## D

DEFAULT_STAGING_DIRECTORY - Static variable in class org.apache.maven.plugins.site.SiteStageMojo
destroy() - Method in class org.apache.maven.plugins.site.webapp.DoxiaFilter
doFilter(ServletRequest, ServletResponse, FilterChain) - Method in class org.apache.maven.plugins.site.webapp.DoxiaFilter
DoxiaBean - Class in org.apache.maven.plugins.site.webapp
  Bean to handle Doxia in a servlet context attribute
DoxiaBean(SiteRenderingContext, Map, File) - Constructor for class org.apache.maven.plugins.site.webapp.DoxiaBean
DoxiaFilter - Class in org.apache.maven.plugins.site.webapp
  Render a page as requested.
DoxiaFilter() - Constructor for class org.apache.maven.plugins.site.webapp.DoxiaFilter

## E

execute() - Method in class org.apache.maven.plugins.site.SiteDeployMojo
execute() - Method in class org.apache.maven.plugins.site.SiteDescriptorAttachMojo
execute() - Method in class org.apache.maven.plugins.site.SiteJarMojo
execute() - Method in class org.apache.maven.plugins.site.SiteMojo
  Generate the project site

  throws MojoExecutionException if any
execute() - Method in class org.apache.maven.plugins.site.SiteRunMojo
execute() - Method in class org.apache.maven.plugins.site.SiteStageDeployMojo
  Generate the project site

  throws MojoExecutionException if any
execute() - Method in class org.apache.maven.plugins.site.SiteStageMojo

## F

filterReports(List) - Method in class org.apache.maven.plugins.site.AbstractSiteRenderingMojo

## G

generate(DecorationModel, File, Locale) - Method in class org.apache.maven.plugins.site.SiteMap
  Generates a sitemap.xml in targetDir/xdoc/.
generate(Sink, SinkFactory, Locale) - Method in interface org.apache.maven.reporting.MavenMultiPageReport
generatedSiteDirectory - Variable in class org.apache.maven.plugins.site.AbstractSiteRenderingMojo
  Directory containing generated documentation.
getArtifactType() - Method in class org.apache.maven.plugins.site.SiteJarMojo
getBaseVersion() - Method in class org.apache.maven.plugins.site.SiteDescriptorArtifactMetadata
getClassifier() - Method in class org.apache.maven.plugins.site.SiteJarMojo
getContext() - Method in class org.apache.maven.plugins.site.webapp.DoxiaBean
getDocuments() - Method in class org.apache.maven.plugins.site.webapp.DoxiaBean
getEncoding() - Method in class org.apache.maven.plugins.site.SiteMap
  Get the encoding to use when writing the output file.
getGeneratedSiteDirectory() - Method in class org.apache.maven.plugins.site.webapp.DoxiaBean
getI18n() - Method in class org.apache.maven.plugins.site.SiteMap
  Get the value of i18n.
getInputEncoding() - Method in class org.apache.maven.plugins.site.AbstractSiteMojo
  Gets the input files encoding.
getKey() - Method in class org.apache.maven.plugins.site.SiteDescriptorArtifactMetadata
getLocalFilename(ArtifactRepository) - Method in class org.apache.maven.plugins.site.SiteDescriptorArtifactMetadata
getOutputEncoding() - Method in class org.apache.maven.plugins.site.AbstractSiteMojo
  Gets the effective reporting output files encoding.
getOutputName() - Method in class org.apache.maven.plugins.site.CategorySummaryDocumentRenderer
getOutputName() - Method in class org.apache.maven.plugins.site.ReportDocumentRenderer
getProxyInfo(Repository, WagonManager) - Static method in class org.apache.maven.plugins.site.SiteDeployMojo
  Get the `ProxyInfo` of the proxy associated with the `host` and the `protocol` of the given `repository`.
getRemoteFilename() - Method in class org.apache.maven.plugins.site.SiteDescriptorArtifactMetadata
getRenderingContext() - Method in class org.apache.maven.plugins.site.CategorySummaryDocumentRenderer
getRenderingContext() - Method in class org.apache.maven.plugins.site.ReportDocumentRenderer
getStagingDirectory(MavenProject, List, File) - Method in class org.apache.maven.plugins.site.SiteStageMojo
  Find the directory where staging will take place.
getStagingSiteURL(MavenProject, List, String) - Method in class org.apache.maven.plugins.site.SiteStageDeployMojo
  Find the URL where staging will take place.
getStructure(MavenProject, boolean) - Static method in class org.apache.maven.plugins.site.SiteStageMojo
  Generates the site structure using the project hiearchy (project and its modules) or using the distributionManagement elements from the pom.xml.
getTopLevelProject(List) - Method in class org.apache.maven.plugins.site.SiteStageMojo
  Find the top level parent in the reactor, i.e.

## I

i18n - Variable in class org.apache.maven.plugins.site.AbstractSiteMojo
  Internationalization.
I18N_DOXIA_CONTEXTS_KEY - Static variable in class org.apache.maven.plugins.site.webapp.DoxiaFilter
init(FilterConfig) - Method in class org.apache.maven.plugins.site.webapp.DoxiaFilter
isExternalReport() - Method in class org.apache.maven.plugins.site.ReportDocumentRenderer
isOverwrite() - Method in class org.apache.maven.plugins.site.CategorySummaryDocumentRenderer
isOverwrite() - Method in class org.apache.maven.plugins.site.ReportDocumentRenderer

## L

locales - Variable in class org.apache.maven.plugins.site.AbstractSiteMojo
  A comma separated list of locales supported by Maven.
LOCALES_LIST_KEY - Static variable in class org.apache.maven.plugins.site.webapp.DoxiaFilter
localRepository - Variable in class org.apache.maven.plugins.site.AbstractSiteMojo
  The local repository.
locateDocuments(SiteRenderingContext, List, Locale) - Method in class org.apache.maven.plugins.site.AbstractSiteRenderingMojo
locateReports(List, Map, Locale) - Method in class org.apache.maven.plugins.site.AbstractSiteRenderingMojo
  Go through the list of reports and process each one like this: Add the report to a map of reports keyed by filename having the report itself as value If the report is not yet in the map of documents, add it together with a suitable renderer

## M

MavenMultiPageReport - Interface in org.apache.maven.reporting
  Temporary class for backwards compatibility.
merge(ArtifactMetadata) - Method in class org.apache.maven.plugins.site.SiteDescriptorArtifactMetadata
moduleExcludes - Variable in class org.apache.maven.plugins.site.AbstractSiteRenderingMojo
  Module type exclusion mappings ex: `fml -> **/*-m1.fml` (excludes fml files ending in '-m1.fml' recursively)

  The configuration looks like this:

## O

org.apache.maven.plugins.site - package org.apache.maven.plugins.site
org.apache.maven.plugins.site.webapp - package org.apache.maven.plugins.site.webapp
org.apache.maven.reporting - package org.apache.maven.reporting
outputDirectory - Variable in class org.apache.maven.plugins.site.SiteMojo
  Directory containing the generated project sites and report distributions.

## P

populateReportItems(DecorationModel, Locale, Map) - Method in class org.apache.maven.plugins.site.AbstractSiteMojo
project - Variable in class org.apache.maven.plugins.site.AbstractSiteMojo
  The maven project.

## R

reactorProjects - Variable in class org.apache.maven.plugins.site.AbstractSiteMojo
  The reactor projects.
renderDocument(Writer, Renderer, SiteRenderingContext) - Method in class org.apache.maven.plugins.site.CategorySummaryDocumentRenderer
renderDocument(Writer, Renderer, SiteRenderingContext) - Method in class org.apache.maven.plugins.site.ReportDocumentRenderer
ReportDocumentRenderer - Class in org.apache.maven.plugins.site
  Renders a Maven report.
ReportDocumentRenderer(MavenReport, RenderingContext, Log) - Constructor for class org.apache.maven.plugins.site.ReportDocumentRenderer
reports - Variable in class org.apache.maven.plugins.site.AbstractSiteRenderingMojo
repositories - Variable in class org.apache.maven.plugins.site.AbstractSiteRenderingMojo
  Remote repositories used for the project.

## S

setContext(SiteRenderingContext) - Method in class org.apache.maven.plugins.site.webapp.DoxiaBean
setDocuments(Map) - Method in class org.apache.maven.plugins.site.webapp.DoxiaBean
setEncoding(String) - Method in class org.apache.maven.plugins.site.SiteMap
  Set the encoding to use when writing the output file.
setGeneratedSiteDirectory(File) - Method in class org.apache.maven.plugins.site.webapp.DoxiaBean
setI18n(I18N) - Method in class org.apache.maven.plugins.site.SiteMap
  Set the value of i18n.
setPort(int) - Method in class org.apache.maven.plugins.site.SiteRunMojo
setTempWebappDirectory(File) - Method in class org.apache.maven.plugins.site.SiteRunMojo
SITE_RENDERER_KEY - Static variable in class org.apache.maven.plugins.site.webapp.DoxiaFilter
SiteDeployMojo - Class in org.apache.maven.plugins.site
  Deploys the generated site using `scp` or `file` protocol to the site URL specified in the `<distributionManagement>` section of the POM.
SiteDeployMojo() - Constructor for class org.apache.maven.plugins.site.SiteDeployMojo
SiteDescriptorArtifactMetadata - Class in org.apache.maven.plugins.site
  Attach a POM to an artifact.
SiteDescriptorArtifactMetadata(Artifact, DecorationModel, File) - Constructor for class org.apache.maven.plugins.site.SiteDescriptorArtifactMetadata
SiteDescriptorAttachMojo - Class in org.apache.maven.plugins.site
  Adds the site descriptor (`site.xml`) to the list of files to be installed/deployed.
SiteDescriptorAttachMojo() - Constructor for class org.apache.maven.plugins.site.SiteDescriptorAttachMojo
siteDirectory - Variable in class org.apache.maven.plugins.site.AbstractSiteMojo
  Directory containing the site.xml file and the source for apt, fml and xdoc docs.
SiteJarMojo - Class in org.apache.maven.plugins.site
  Bundles the site output into a JAR so that it can be deployed to a repository.
SiteJarMojo() - Constructor for class org.apache.maven.plugins.site.SiteJarMojo
SiteMap - Class in org.apache.maven.plugins.site
  Generate a sitemap.
SiteMap(String, I18N) - Constructor for class org.apache.maven.plugins.site.SiteMap
SiteMojo - Class in org.apache.maven.plugins.site
  Generates the site for a single project.
SiteMojo() - Constructor for class org.apache.maven.plugins.site.SiteMojo
siteRenderer - Variable in class org.apache.maven.plugins.site.AbstractSiteRenderingMojo
  Site renderer.
SiteRunMojo - Class in org.apache.maven.plugins.site
  Starts the site up, rendering documents as requested for faster editing.
SiteRunMojo() - Constructor for class org.apache.maven.plugins.site.SiteRunMojo
SiteStageDeployMojo - Class in org.apache.maven.plugins.site
  Deploys the generated site to a staging or mock directory to the site URL specified in the `<distributionManagement>` section of the POM.
SiteStageDeployMojo() - Constructor for class org.apache.maven.plugins.site.SiteStageDeployMojo
SiteStageMojo - Class in org.apache.maven.plugins.site
  Generates a site in a local staging or mock directory based on the site URL specified in the `<distributionManagement>` section of the POM.
SiteStageMojo() - Constructor for class org.apache.maven.plugins.site.SiteStageMojo
siteTool - Variable in class org.apache.maven.plugins.site.AbstractSiteMojo
  SiteTool.
stagingDirectory - Variable in class org.apache.maven.plugins.site.SiteStageMojo
  Staging directory location.
storedInArtifactVersionDirectory() - Method in class org.apache.maven.plugins.site.SiteDescriptorArtifactMetadata
storeInLocalRepository(ArtifactRepository, ArtifactRepository) - Method in class org.apache.maven.plugins.site.SiteDescriptorArtifactMetadata

## T

toRelative(File, String) - Static method in class org.apache.maven.plugins.site.AbstractSiteMojo
  TODO should be removed see PLXUTILS-61
toString() - Method in class org.apache.maven.plugins.site.SiteDescriptorArtifactMetadata

A C D E F G I L M O P R S T

Copyright © 2011. All Rights Reserved.