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
 

C

categoriseReports(Collection) - Method in class org.apache.maven.plugins.site.AbstractSiteRenderingMojo
 
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
 
compare(Object, Object) - Method in class org.apache.maven.plugins.site.ReportComparator
 
createSiteRenderingContext(Locale) - Method in class org.apache.maven.plugins.site.AbstractSiteRenderingMojo
 

D

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
 
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.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
 
execute() - Method in class org.apache.maven.plugins.site.SiteStageMojo
 

F

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

G

generatedSiteDirectory - Variable in class org.apache.maven.plugins.site.AbstractSiteRenderingMojo
Directory containing generated documentation.
getAvailableLocales() - Method in class org.apache.maven.plugins.site.AbstractSiteMojo
Init the localesList variable.
getBaseVersion() - Method in class org.apache.maven.plugins.site.SiteDescriptorArtifactMetadata
 
getDecorationModel(MavenProject, Locale, Map) - Method in class org.apache.maven.plugins.site.AbstractSiteRenderingMojo
 
getInterpolatedSiteDescriptorContent(Map, MavenProject, String) - Method in class org.apache.maven.plugins.site.AbstractSiteMojo
 
getKey() - Method in class org.apache.maven.plugins.site.SiteDescriptorArtifactMetadata
 
getLocalFilename(ArtifactRepository) - Method in class org.apache.maven.plugins.site.SiteDescriptorArtifactMetadata
 
getOutputName() - Method in class org.apache.maven.plugins.site.CategorySummaryDocumentRenderer
 
getOutputName() - Method in class org.apache.maven.plugins.site.ReportDocumentRenderer
 
getParentProject(MavenProject) - Method in class org.apache.maven.plugins.site.AbstractSiteMojo
Returns the parent POM URL.
getProxyInfo(Settings) - Static method in class org.apache.maven.plugins.site.SiteDeployMojo
Convenience method to map a Proxy object from the user system settings to a ProxyInfo object.
getRelativePath(String, String) - Method in class org.apache.maven.plugins.site.AbstractSiteMojo
 
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
 
getSiteDescriptorFile(File, Locale) - Method in class org.apache.maven.plugins.site.AbstractSiteMojo
Get the path of the site descriptor for a given locale.
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.

I

i18n - Variable in class org.apache.maven.plugins.site.AbstractSiteMojo
Internationalization.
init(FilterConfig) - Method in class org.apache.maven.plugins.site.webapp.DoxiaFilter
 
inputEncoding - Variable in class org.apache.maven.plugins.site.AbstractSiteMojo
Specifies the input encoding.
isOverwrite() - Method in class org.apache.maven.plugins.site.CategorySummaryDocumentRenderer
 
isOverwrite() - Method in class org.apache.maven.plugins.site.ReportDocumentRenderer
 

L

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
 

M

mavenProjectBuilder - Variable in class org.apache.maven.plugins.site.AbstractSiteMojo
Project builder
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 -m1.fml files)

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
 
outputDirectory - Variable in class org.apache.maven.plugins.site.SiteMojo
Directory containing the generated project sites and report distributions.
outputEncoding - Variable in class org.apache.maven.plugins.site.AbstractSiteMojo
Specifies the output encoding.

P

populateModules(DecorationModel, Locale, boolean) - Method in class org.apache.maven.plugins.site.AbstractSiteMojo
 
populateProjectParentMenu(DecorationModel, Locale, MavenProject, boolean) - Method in class org.apache.maven.plugins.site.AbstractSiteMojo
 
populateReportItems(DecorationModel, Locale, Map) - Method in class org.apache.maven.plugins.site.AbstractSiteMojo
 
populateReportsMenu(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
 
ReportComparator - Class in org.apache.maven.plugins.site
Sorts reports.
ReportComparator(Locale) - Constructor for class org.apache.maven.plugins.site.ReportComparator
 
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

setPort(int) - Method in class org.apache.maven.plugins.site.SiteRunMojo
 
setTempWebappDirectory(File) - Method in class org.apache.maven.plugins.site.SiteRunMojo
 
SiteDeployMojo - Class in org.apache.maven.plugins.site
Deploys website using scp/file protocol.
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 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 source for apt, fml and xdoc docs.
SiteMojo - Class in org.apache.maven.plugins.site
Generates the project site.
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
Start the site up, rendering documents as requested for fast editing.
SiteRunMojo() - Constructor for class org.apache.maven.plugins.site.SiteRunMojo
 
SiteStageDeployMojo - Class in org.apache.maven.plugins.site
Deploy a staging site in specific directory.
SiteStageDeployMojo() - Constructor for class org.apache.maven.plugins.site.SiteStageDeployMojo
 
SiteStageMojo - Class in org.apache.maven.plugins.site
Staging a site in specific directory.
SiteStageMojo() - Constructor for class org.apache.maven.plugins.site.SiteStageMojo
 
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

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 © 2002-2006 Apache Software Foundation. All Rights Reserved.