Index
All Classes and Interfaces|All Packages|Constant Field Values
A
- AbstractDeployMojo - Class in org.apache.maven.plugins.site.deploy
-
Abstract base class for deploy mojos.
- AbstractDeployMojo() - Constructor for class org.apache.maven.plugins.site.deploy.AbstractDeployMojo
- AbstractDeployMojo.URIEncoder - Class in org.apache.maven.plugins.site.deploy
- AbstractSiteDescriptorMojo - Class in org.apache.maven.plugins.site.descriptor
-
Abstract class to compute effective site model for site descriptors.
- AbstractSiteDescriptorMojo() - Constructor for class org.apache.maven.plugins.site.descriptor.AbstractSiteDescriptorMojo
- 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.render
-
Base class for site rendering mojos.
- AbstractSiteRenderingMojo() - Constructor for class org.apache.maven.plugins.site.render.AbstractSiteRenderingMojo
- AbstractStagingMojo - Class in org.apache.maven.plugins.site.deploy
-
Abstract base class for staging mojos.
- AbstractStagingMojo() - Constructor for class org.apache.maven.plugins.site.deploy.AbstractStagingMojo
- append(StringBuilder, String, int) - Method in class org.apache.maven.plugins.maven_site_plugin.HelpMojo
-
Append a description to the buffer by respecting the indentSize and lineLength parameters.
- append(String, String) - Method in class org.apache.maven.plugins.site.descriptor.AbstractSiteDescriptorMojo
- appendSlash(String) - Static method in class org.apache.maven.plugins.site.deploy.AbstractDeployMojo
-
Make sure the given URL ends with a slash.
- archive - Variable in class org.apache.maven.plugins.site.render.SiteJarMojo
-
The archive configuration to use.
- archiveExcludes - Variable in class org.apache.maven.plugins.site.render.SiteJarMojo
-
List of files to exclude.
- archiveIncludes - Variable in class org.apache.maven.plugins.site.render.SiteJarMojo
-
List of files to include.
- assembler - Variable in class org.apache.maven.plugins.site.descriptor.AbstractSiteDescriptorMojo
-
The component for assembling site model inheritance.
- attach - Variable in class org.apache.maven.plugins.site.render.SiteJarMojo
-
Specifies whether to attach the generated artifact to the project.
- attributes - Variable in class org.apache.maven.plugins.site.render.AbstractSiteRenderingMojo
-
Additional template properties for rendering the site.
B
- basedir - Variable in class org.apache.maven.plugins.site.descriptor.SiteDescriptorAttachMojo
- build() - Method in class org.apache.maven.plugins.maven_site_plugin.HelpMojo
C
- categoriseReports(Collection<MavenReport>) - Method in class org.apache.maven.plugins.site.render.AbstractSiteRenderingMojo
-
Go through the collection of reports and put each report into a list for the appropriate category.
- categoryReports - Variable in class org.apache.maven.plugins.site.render.CategorySummaryDocumentRenderer
- CategorySummaryDocumentRenderer - Class in org.apache.maven.plugins.site.render
-
Renders a Maven report.
- CategorySummaryDocumentRenderer(MojoExecution, DocumentRenderingContext, String, String, String, I18N, List<MavenReport>, Log) - Constructor for class org.apache.maven.plugins.site.render.CategorySummaryDocumentRenderer
- checkInputEncoding() - Method in class org.apache.maven.plugins.site.render.AbstractSiteRenderingMojo
- chmod - Variable in class org.apache.maven.plugins.site.deploy.AbstractDeployMojo
-
Whether to run the "chmod" command on the remote site after the deploy.
- chmod(Wagon, Repository, String, String) - Static method in class org.apache.maven.plugins.site.deploy.AbstractDeployMojo
- chmodMode - Variable in class org.apache.maven.plugins.site.deploy.AbstractDeployMojo
-
The mode used by the "chmod" command.
- chmodOptions - Variable in class org.apache.maven.plugins.site.deploy.AbstractDeployMojo
-
The options used by the "chmod" command.
- classLoader - Variable in class org.apache.maven.plugins.site.render.ReportDocumentRenderer
- container - Variable in class org.apache.maven.plugins.site.deploy.AbstractDeployMojo
- context - Variable in class org.apache.maven.plugins.site.run.DoxiaBean
- createArchive(File, String) - Method in class org.apache.maven.plugins.site.render.SiteJarMojo
-
Method that creates the jar file.
- createSink(File, String) - Method in class org.apache.maven.plugins.site.render.ReportDocumentRenderer.MultiPageSinkFactory
- createSink(File, String, String) - Method in class org.apache.maven.plugins.site.render.ReportDocumentRenderer.MultiPageSinkFactory
- createSink(OutputStream) - Method in class org.apache.maven.plugins.site.render.ReportDocumentRenderer.MultiPageSinkFactory
- createSink(OutputStream, String) - Method in class org.apache.maven.plugins.site.render.ReportDocumentRenderer.MultiPageSinkFactory
- createSiteRenderingContext(Locale) - Method in class org.apache.maven.plugins.site.render.AbstractSiteRenderingMojo
- createWebApplication() - Method in class org.apache.maven.plugins.site.run.SiteRunMojo
D
- DEFAULT_ARCHIVE_EXCLUDES - Static variable in class org.apache.maven.plugins.site.render.SiteJarMojo
- DEFAULT_ARCHIVE_INCLUDES - Static variable in class org.apache.maven.plugins.site.render.SiteJarMojo
- DEFAULT_LINE_LENGTH - Static variable in class org.apache.maven.plugins.maven_site_plugin.HelpMojo
- DEFAULT_STAGING_DIRECTORY - Static variable in class org.apache.maven.plugins.site.deploy.AbstractStagingMojo
-
The String "staging/".
- deploy(File, Repository) - Method in class org.apache.maven.plugins.site.deploy.AbstractDeployMojo
- deploySite - Variable in class org.apache.maven.plugins.site.deploy.AbstractDeployMojo
- deployTo(Repository) - Method in class org.apache.maven.plugins.site.deploy.AbstractDeployMojo
-
Use wagon to deploy the generated site to a given repository.
- desc1 - Variable in class org.apache.maven.plugins.site.render.CategorySummaryDocumentRenderer
- desc2 - Variable in class org.apache.maven.plugins.site.render.CategorySummaryDocumentRenderer
- destroy() - Method in class org.apache.maven.plugins.site.run.DoxiaFilter
- detail - Variable in class org.apache.maven.plugins.maven_site_plugin.HelpMojo
-
If
true
, display all settable properties for each goal. - determineDeploySite() - Method in class org.apache.maven.plugins.site.deploy.AbstractDeployMojo
- determineDeploySite() - Method in class org.apache.maven.plugins.site.deploy.SiteDeployMojo
-
Deploy directly to the current project's distribution management site.
- determineDeploySite() - Method in class org.apache.maven.plugins.site.deploy.SiteStageDeployMojo
- determineDeploySite() - Method in class org.apache.maven.plugins.site.deploy.SiteStageMojo
- determineStageDeploySiteURL() - Method in class org.apache.maven.plugins.site.deploy.SiteStageDeployMojo
-
Find the URL where staging will take place.
- determineStagingDirectory() - Method in class org.apache.maven.plugins.site.deploy.SiteStageMojo
-
Find the directory where staging will take place.
- determineStagingSiteId() - Method in class org.apache.maven.plugins.site.deploy.SiteStageDeployMojo
- determineTopDistributionManagementSiteUrl() - Method in class org.apache.maven.plugins.site.deploy.AbstractDeployMojo
- determineTopDistributionManagementSiteUrl() - Method in class org.apache.maven.plugins.site.deploy.AbstractStagingMojo
-
By default, staging mojos will get their top distribution management site url by getting top parent with the same site, which is a good heuristics.
- determineTopDistributionManagementSiteUrl() - Method in class org.apache.maven.plugins.site.deploy.SiteDeployMojo
-
Deploy distribution site url is directly the current project value.
- determineTopDistributionManagementSiteUrl() - Method in class org.apache.maven.plugins.site.deploy.SiteStageDeployMojo
-
If
stagingSiteURL
is configured, top most parent with same staging site url will be used. - docRenderingContext - Variable in class org.apache.maven.plugins.site.render.CategorySummaryDocumentRenderer
- docRenderingContext - Variable in class org.apache.maven.plugins.site.render.ReportDocumentRenderer
- docRenderingContext - Variable in class org.apache.maven.plugins.site.render.ReportDocumentRenderer.MultiPageSinkFactory
-
The main DocumentRenderingContext, which is the base for the DocumentRenderingContext of subpages
- docRenderingContext - Variable in class org.apache.maven.plugins.site.render.SitemapDocumentRenderer
- documents - Variable in class org.apache.maven.plugins.site.run.DoxiaBean
- doFilter(ServletRequest, ServletResponse, FilterChain) - Method in class org.apache.maven.plugins.site.run.DoxiaFilter
- DoxiaBean - Class in org.apache.maven.plugins.site.run
-
Bean to handle Doxia in a servlet context attribute
- DoxiaBean(SiteRenderingContext, Map<String, DocumentRenderer>) - Constructor for class org.apache.maven.plugins.site.run.DoxiaBean
- DoxiaFilter - Class in org.apache.maven.plugins.site.run
-
Render a page as requested.
- DoxiaFilter() - Constructor for class org.apache.maven.plugins.site.run.DoxiaFilter
E
- EffectiveSiteMojo - Class in org.apache.maven.plugins.site.descriptor
-
Displays the effective site descriptor as an XML for this build, after inheritance and interpolation of
site.xml
, for the first locale. - EffectiveSiteMojo() - Constructor for class org.apache.maven.plugins.site.descriptor.EffectiveSiteMojo
- encodeURI(String) - Static method in class org.apache.maven.plugins.site.deploy.AbstractDeployMojo.URIEncoder
- execute() - Method in class org.apache.maven.plugins.maven_site_plugin.HelpMojo
- execute() - Method in class org.apache.maven.plugins.site.deploy.AbstractDeployMojo
- execute() - Method in class org.apache.maven.plugins.site.deploy.SiteStageMojo
- execute() - Method in class org.apache.maven.plugins.site.descriptor.EffectiveSiteMojo
- execute() - Method in class org.apache.maven.plugins.site.descriptor.SiteDescriptorAttachMojo
- execute() - Method in class org.apache.maven.plugins.site.render.SiteJarMojo
- execute() - Method in class org.apache.maven.plugins.site.render.SiteMojo
- execute() - Method in class org.apache.maven.plugins.site.run.SiteRunMojo
- extractItems(List<MenuItem>, Sink) - Static method in class org.apache.maven.plugins.site.render.SitemapDocumentRenderer
F
- file - Variable in class org.apache.maven.plugins.site.descriptor.SiteDescriptorArtifactMetadata
- finalName - Variable in class org.apache.maven.plugins.site.render.SiteJarMojo
-
Specifies the filename that will be used for the generated jar file.
- findNamedChild(Node, String) - Static method in class org.apache.maven.plugins.maven_site_plugin.HelpMojo
- findSingleChild(Node, String) - Static method in class org.apache.maven.plugins.maven_site_plugin.HelpMojo
G
- generatedSiteDirectory - Variable in class org.apache.maven.plugins.site.render.AbstractSiteRenderingMojo
-
Directory containing generated documentation in source format (Doxia supported markup).
- generateProjectInfo - Variable in class org.apache.maven.plugins.site.render.AbstractSiteRenderingMojo
-
Whether to generate the summary page for project reports: project-info.html.
- generateReports - Variable in class org.apache.maven.plugins.site.render.SiteMojo
-
Convenience parameter that allows you to disable report generation.
- generateSitemap - Variable in class org.apache.maven.plugins.site.render.AbstractSiteRenderingMojo
-
Generate a sitemap.
- getArchiveExcludes() - Method in class org.apache.maven.plugins.site.render.SiteJarMojo
- getArchiveIncludes() - Method in class org.apache.maven.plugins.site.render.SiteJarMojo
- getArtifactType() - Method in class org.apache.maven.plugins.site.render.SiteJarMojo
- getAuthenticationInfo(String) - Method in class org.apache.maven.plugins.site.deploy.AbstractDeployMojo
- getBaseVersion() - Method in class org.apache.maven.plugins.site.descriptor.SiteDescriptorArtifactMetadata
- getClassifier() - Method in class org.apache.maven.plugins.site.render.SiteJarMojo
- getClassifier(File) - Static method in class org.apache.maven.plugins.site.descriptor.SiteDescriptorAttachMojo
- getContext() - Method in class org.apache.maven.plugins.site.run.DoxiaBean
- getDeployModuleDirectory() - Method in class org.apache.maven.plugins.site.deploy.AbstractDeployMojo
-
Find the relative path between the distribution URLs of the top site and the current project.
- getDeploySite() - Method in class org.apache.maven.plugins.site.deploy.AbstractDeployMojo
-
Get the site used for deployment, with its id to look up credential settings and the target URL for the deploy.
- getDocuments() - Method in class org.apache.maven.plugins.site.run.DoxiaBean
- getExecutionRootBuildDirectory() - Method in class org.apache.maven.plugins.site.deploy.SiteStageMojo
-
Find the build directory of the execution root project in the reactor.
- getFilename() - Method in class org.apache.maven.plugins.site.descriptor.SiteDescriptorArtifactMetadata
- getFullName(MavenProject) - Static method in class org.apache.maven.plugins.site.deploy.AbstractDeployMojo
- getIndentLevel(String) - Static method in class org.apache.maven.plugins.maven_site_plugin.HelpMojo
-
Gets the indentation level of the specified line.
- getInputEncoding() - Method in class org.apache.maven.plugins.site.render.AbstractSiteRenderingMojo
-
Gets the input files encoding.
- getKey() - Method in class org.apache.maven.plugins.site.descriptor.SiteDescriptorArtifactMetadata
- getLocales() - Method in class org.apache.maven.plugins.site.AbstractSiteMojo
- getLocalFilename(ArtifactRepository) - Method in class org.apache.maven.plugins.site.descriptor.SiteDescriptorArtifactMetadata
- getOutputDirectory() - Method in class org.apache.maven.plugins.site.render.ReportDocumentRenderer.MultiPageSubSink
- getOutputDirectory(Locale) - Method in class org.apache.maven.plugins.site.render.SiteMojo
- getOutputDirectory(Locale) - Method in class org.apache.maven.plugins.site.run.SiteRunMojo
- getOutputEncoding() - Method in class org.apache.maven.plugins.site.render.AbstractSiteRenderingMojo
-
Gets the effective reporting output files encoding.
- getOutputName() - Method in class org.apache.maven.plugins.site.render.CategorySummaryDocumentRenderer
- getOutputName() - Method in class org.apache.maven.plugins.site.render.ReportDocumentRenderer
- getOutputName() - Method in class org.apache.maven.plugins.site.render.ReportDocumentRenderer.MultiPageSubSink
- getOutputName() - Method in class org.apache.maven.plugins.site.render.SitemapDocumentRenderer
- getOutputPath() - Method in class org.apache.maven.plugins.site.render.ReportDocumentRenderer
- getOutputPath() - Method in class org.apache.maven.plugins.site.render.SitemapDocumentRenderer
- getProject() - Method in class org.apache.maven.plugins.site.render.SiteMojo
- getPropertyFromExpression(String) - Static method in class org.apache.maven.plugins.maven_site_plugin.HelpMojo
- getProxy(Repository, SettingsDecrypter) - Method in class org.apache.maven.plugins.site.deploy.AbstractDeployMojo
-
Get proxy information.
- getRemoteFilename() - Method in class org.apache.maven.plugins.site.descriptor.SiteDescriptorArtifactMetadata
- getRenderingContext() - Method in class org.apache.maven.plugins.site.render.CategorySummaryDocumentRenderer
- getRenderingContext() - Method in class org.apache.maven.plugins.site.render.ReportDocumentRenderer
- getRenderingContext() - Method in class org.apache.maven.plugins.site.render.SitemapDocumentRenderer
- getReportingPlugins() - Method in class org.apache.maven.plugins.site.render.AbstractSiteRenderingMojo
-
Get the report plugins from reporting section, adding if necessary (i.e.
- getReportMojoInfo() - Method in class org.apache.maven.plugins.site.render.CategorySummaryDocumentRenderer
- getReportMojoInfo() - Method in class org.apache.maven.plugins.site.render.ReportDocumentRenderer
- getReportMojoInfo() - Method in class org.apache.maven.plugins.site.render.SitemapDocumentRenderer
- getReportMojoInfo() - Method in interface org.apache.maven.plugins.site.render.SitePluginReportDocumentRenderer
- getReports(File) - Method in class org.apache.maven.plugins.site.render.AbstractSiteRenderingMojo
- getSession() - Method in class org.apache.maven.plugins.site.render.SiteMojo
- getSingleChild(Node, String) - Static method in class org.apache.maven.plugins.maven_site_plugin.HelpMojo
- getSite(MavenProject) - Static method in class org.apache.maven.plugins.site.deploy.AbstractDeployMojo
-
Extract the distributionManagement site from the given MavenProject.
- getStagingSiteURL(MavenProject) - Method in class org.apache.maven.plugins.site.deploy.SiteStageDeployMojo
-
Extract the value of the stagingSiteURL configuration parameter of maven-site-plugin for the given project.
- getTopDistributionManagementSiteUrl() - Method in class org.apache.maven.plugins.site.deploy.AbstractDeployMojo
-
Get the top distribution management site url, used for module relative path calculations.
- getTopLevelProject(MavenProject) - Method in class org.apache.maven.plugins.site.deploy.AbstractDeployMojo
-
Extract the distributionManagement site of the top level parent of the given MavenProject.
- getTopMostParentWithSameStagingSiteURL() - Method in class org.apache.maven.plugins.site.deploy.SiteStageDeployMojo
-
Extract the distributionManagement.site of the top most project in the hierarchy that specifies a stagingSiteURL, starting at the actual MavenProject.
- getValue(Node, String) - Static method in class org.apache.maven.plugins.maven_site_plugin.HelpMojo
- getWagon(Repository) - Method in class org.apache.maven.plugins.site.deploy.AbstractDeployMojo
- goal - Variable in class org.apache.maven.plugins.maven_site_plugin.HelpMojo
-
The name of the goal for which to show help.
H
- HelpMojo - Class in org.apache.maven.plugins.maven_site_plugin
-
Display help information on maven-site-plugin.
Callmvn site:help -Ddetail=true -Dgoal=<goal-name>
to display parameter details. - HelpMojo() - Constructor for class org.apache.maven.plugins.maven_site_plugin.HelpMojo
- host - Variable in class org.apache.maven.plugins.site.run.SiteRunMojo
-
The host to execute the HTTP server on.
I
- i18n - Variable in class org.apache.maven.plugins.site.AbstractSiteMojo
-
Internationalization.
- i18n - Variable in class org.apache.maven.plugins.site.render.CategorySummaryDocumentRenderer
- i18n - Variable in class org.apache.maven.plugins.site.render.SitemapDocumentRenderer
- I18N_DOXIA_CONTEXTS_KEY - Static variable in class org.apache.maven.plugins.site.run.DoxiaFilter
- i18nDoxiaContexts - Variable in class org.apache.maven.plugins.site.run.DoxiaFilter
- indentSize - Variable in class org.apache.maven.plugins.maven_site_plugin.HelpMojo
-
The number of spaces per indentation level, should be positive.
- init(FilterConfig) - Method in class org.apache.maven.plugins.site.run.DoxiaFilter
- inputDirectory - Variable in class org.apache.maven.plugins.site.deploy.AbstractDeployMojo
-
Directory containing the generated project sites and report distributions.
- inputEncoding - Variable in class org.apache.maven.plugins.site.render.AbstractSiteRenderingMojo
-
Specifies the input encoding.
- isDeploy() - Method in class org.apache.maven.plugins.site.deploy.AbstractDeployMojo
-
Detect if the mojo is staging or deploying.
- isDeploy() - Method in class org.apache.maven.plugins.site.deploy.SiteDeployMojo
- isDeploy() - Method in class org.apache.maven.plugins.site.deploy.SiteStageDeployMojo
- isDeploy() - Method in class org.apache.maven.plugins.site.deploy.SiteStageMojo
- isExternalReport() - Method in class org.apache.maven.plugins.site.render.CategorySummaryDocumentRenderer
- isExternalReport() - Method in class org.apache.maven.plugins.site.render.ReportDocumentRenderer
- isExternalReport() - Method in class org.apache.maven.plugins.site.render.SitemapDocumentRenderer
- isNotEmpty(String) - Static method in class org.apache.maven.plugins.maven_site_plugin.HelpMojo
- isOverwrite() - Method in class org.apache.maven.plugins.site.render.CategorySummaryDocumentRenderer
- isOverwrite() - Method in class org.apache.maven.plugins.site.render.ReportDocumentRenderer
- isOverwrite() - Method in class org.apache.maven.plugins.site.render.SitemapDocumentRenderer
J
- jarArchiver - Variable in class org.apache.maven.plugins.site.render.SiteJarMojo
-
The Jar archiver.
- jarOutputDirectory - Variable in class org.apache.maven.plugins.site.render.SiteJarMojo
-
Specifies the directory where the generated jar file will be put.
L
- lineLength - Variable in class org.apache.maven.plugins.maven_site_plugin.HelpMojo
-
The maximum length of a display line, should be positive.
- locales - Variable in class org.apache.maven.plugins.site.AbstractSiteMojo
-
A comma separated list of locales to render.
- LOCALES_LIST_KEY - Static variable in class org.apache.maven.plugins.site.run.DoxiaFilter
- localesList - Variable in class org.apache.maven.plugins.site.run.DoxiaFilter
- locateDocuments(SiteRenderingContext, List<MavenReportExecution>, Locale) - Method in class org.apache.maven.plugins.site.render.AbstractSiteRenderingMojo
-
Locate every document to be rendered for given locale: handwritten content, ie Doxia files, reports, "Project Information" and "Project Reports" category summaries.
- locateReports(List<MavenReportExecution>, Map<String, DocumentRenderer>, Locale) - Method in class org.apache.maven.plugins.site.render.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
- log - Variable in class org.apache.maven.plugins.site.render.CategorySummaryDocumentRenderer
- log - Variable in class org.apache.maven.plugins.site.render.ReportDocumentRenderer
- log - Variable in class org.apache.maven.plugins.site.render.SitemapDocumentRenderer
- logDocumentRenderer(String, String, DocumentRenderer) - Method in class org.apache.maven.plugins.site.run.DoxiaFilter
M
- MARK - Static variable in class org.apache.maven.plugins.site.deploy.AbstractDeployMojo.URIEncoder
- mavenReportExecutor - Variable in class org.apache.maven.plugins.site.render.AbstractSiteRenderingMojo
- mavenSession - Variable in class org.apache.maven.plugins.site.deploy.AbstractDeployMojo
- mavenSession - Variable in class org.apache.maven.plugins.site.render.AbstractSiteRenderingMojo
-
The current Maven session.
- merge(ArtifactMetadata) - Method in class org.apache.maven.plugins.site.descriptor.SiteDescriptorArtifactMetadata
- merge(ArtifactMetadata) - Method in class org.apache.maven.plugins.site.descriptor.SiteDescriptorArtifactMetadata
- moduleExcludes - Variable in class org.apache.maven.plugins.site.render.AbstractSiteRenderingMojo
-
Module type exclusion mappings ex:
fml -> **/*-m1.fml
(excludes fml files ending in '-m1.fml' recursively) - mojoExecution - Variable in class org.apache.maven.plugins.site.render.AbstractSiteRenderingMojo
-
The mojo execution
- MultiPageSinkFactory(MavenReport, DocumentRenderingContext) - Constructor for class org.apache.maven.plugins.site.render.ReportDocumentRenderer.MultiPageSinkFactory
- MultiPageSubSink(File, String, DocumentRenderingContext) - Constructor for class org.apache.maven.plugins.site.render.ReportDocumentRenderer.MultiPageSubSink
O
- org.apache.maven.plugins.maven_site_plugin - package org.apache.maven.plugins.maven_site_plugin
- org.apache.maven.plugins.site - package org.apache.maven.plugins.site
- org.apache.maven.plugins.site.deploy - package org.apache.maven.plugins.site.deploy
- org.apache.maven.plugins.site.descriptor - package org.apache.maven.plugins.site.descriptor
- org.apache.maven.plugins.site.render - package org.apache.maven.plugins.site.render
- org.apache.maven.plugins.site.run - package org.apache.maven.plugins.site.run
- output - Variable in class org.apache.maven.plugins.site.descriptor.EffectiveSiteMojo
-
Optional parameter to write the output of this help in a given file, instead of writing to the console.
- OUTPUT_DIRECTORY_KEY - Static variable in class org.apache.maven.plugins.site.run.DoxiaFilter
- outputDirectory - Variable in class org.apache.maven.plugins.site.render.ReportDocumentRenderer.MultiPageSubSink
- outputDirectory - Variable in class org.apache.maven.plugins.site.render.SiteMojo
-
Directory where the project sites and report distributions will be generated (as html/css/...).
- outputDirectory - Variable in class org.apache.maven.plugins.site.run.DoxiaFilter
- outputEncoding - Variable in class org.apache.maven.plugins.site.render.AbstractSiteRenderingMojo
-
Specifies the output encoding.
- outputName - Variable in class org.apache.maven.plugins.site.render.ReportDocumentRenderer.MultiPageSubSink
- outputTimestamp - Variable in class org.apache.maven.plugins.site.render.AbstractSiteRenderingMojo
-
Timestamp for reproducible output archive entries, either formatted as ISO 8601
yyyy-MM-dd'T'HH:mm:ssXXX
or as an int representing seconds since the epoch (like SOURCE_DATE_EPOCH).
P
- PLUGIN_HELP_PATH - Static variable in class org.apache.maven.plugins.maven_site_plugin.HelpMojo
- pomPackagingOnly - Variable in class org.apache.maven.plugins.site.descriptor.SiteDescriptorAttachMojo
-
Attach site descriptor only if packaging is pom.
- populateItemRefs(List<MenuItem>, Locale, Map<String, MavenReport>) - Method in class org.apache.maven.plugins.site.render.AbstractSiteRenderingMojo
- populateReportItems(SiteModel, Locale, Map<String, MavenReport>) - Method in class org.apache.maven.plugins.site.render.AbstractSiteRenderingMojo
- port - Variable in class org.apache.maven.plugins.site.run.SiteRunMojo
-
The port to execute the HTTP server on.
- prepareSiteModel(Locale) - Method in class org.apache.maven.plugins.site.descriptor.AbstractSiteDescriptorMojo
- project - Variable in class org.apache.maven.plugins.site.AbstractSiteMojo
-
The Maven project.
- projectHelper - Variable in class org.apache.maven.plugins.site.descriptor.SiteDescriptorAttachMojo
-
Maven ProjectHelper.
- projectHelper - Variable in class org.apache.maven.plugins.site.render.SiteJarMojo
-
Used for attaching the artifact in the project.
- push(File, Repository, Wagon, ProxyInfo, List<Locale>, String) - Method in class org.apache.maven.plugins.site.deploy.AbstractDeployMojo
R
- reactorProjects - Variable in class org.apache.maven.plugins.site.descriptor.AbstractSiteDescriptorMojo
-
The reactor projects.
- relativePath(String) - Static method in class org.apache.maven.plugins.site.render.SitemapDocumentRenderer
- relativizeSiteLinks - Variable in class org.apache.maven.plugins.site.descriptor.AbstractSiteDescriptorMojo
-
Make links in the site descriptor relative to the project URL.
- remoteProjectRepositories - Variable in class org.apache.maven.plugins.site.descriptor.AbstractSiteDescriptorMojo
-
Remote project repositories used for the project.
- renderDocument(Writer, SiteRenderer, SiteRenderingContext) - Method in class org.apache.maven.plugins.site.render.CategorySummaryDocumentRenderer
- renderDocument(Writer, SiteRenderer, SiteRenderingContext) - Method in class org.apache.maven.plugins.site.render.ReportDocumentRenderer
- renderDocument(Writer, SiteRenderer, SiteRenderingContext) - Method in class org.apache.maven.plugins.site.render.SitemapDocumentRenderer
- renderDoxiaDocuments(Collection<DocumentRenderer>, SiteRenderingContext, File) - Method in class org.apache.maven.plugins.site.render.SiteMojo
-
Render Doxia documents from the list given, but not reports.
- renderLocale(Locale, List<MavenReportExecution>, List<Locale>, File) - Method in class org.apache.maven.plugins.site.render.SiteMojo
- renderNonDoxiaDocuments(Collection<DocumentRenderer>, SiteRenderingContext, File) - Method in class org.apache.maven.plugins.site.render.SiteMojo
-
Render non-Doxia documents (e.g., reports) from the list given
- repeat(String, int) - Static method in class org.apache.maven.plugins.maven_site_plugin.HelpMojo
-
Repeat a String
n
times to form a new string. - report - Variable in class org.apache.maven.plugins.site.render.ReportDocumentRenderer.MultiPageSinkFactory
-
The report that is (maybe) generating multiple pages
- report - Variable in class org.apache.maven.plugins.site.render.ReportDocumentRenderer
- ReportDocumentRenderer - Class in org.apache.maven.plugins.site.render
-
Renders a Maven report in a Doxia site.
- ReportDocumentRenderer(MavenReportExecution, DocumentRenderingContext, Log) - Constructor for class org.apache.maven.plugins.site.render.ReportDocumentRenderer
- ReportDocumentRenderer.MultiPageSinkFactory - Class in org.apache.maven.plugins.site.render
- ReportDocumentRenderer.MultiPageSubSink - Class in org.apache.maven.plugins.site.render
- reporting - Variable in class org.apache.maven.plugins.site.render.AbstractSiteRenderingMojo
-
replaces previous reportPlugins parameter, that was injected by Maven core from reporting section: but this new configuration format has been abandoned.
- reportMojoInfo - Variable in class org.apache.maven.plugins.site.render.CategorySummaryDocumentRenderer
- reportMojoInfo - Variable in class org.apache.maven.plugins.site.render.ReportDocumentRenderer
- reportMojoInfo - Variable in class org.apache.maven.plugins.site.render.SitemapDocumentRenderer
- repoSession - Variable in class org.apache.maven.plugins.site.descriptor.AbstractSiteDescriptorMojo
- RESERVED - Static variable in class org.apache.maven.plugins.site.deploy.AbstractDeployMojo.URIEncoder
S
- saveProcessedContent - Variable in class org.apache.maven.plugins.site.render.AbstractSiteRenderingMojo
-
Whether to save Velocity processed Doxia content (
*.<ext>.vm
) to${generatedSiteDirectory}/processed
. - servletContext - Variable in class org.apache.maven.plugins.site.run.DoxiaFilter
- setContext(SiteRenderingContext) - Method in class org.apache.maven.plugins.site.run.DoxiaBean
- setDocuments(Map<String, DocumentRenderer>) - Method in class org.apache.maven.plugins.site.run.DoxiaBean
- setPort(int) - Method in class org.apache.maven.plugins.site.run.SiteRunMojo
- setTempWebappDirectory(File) - Method in class org.apache.maven.plugins.site.run.SiteRunMojo
- settings - Variable in class org.apache.maven.plugins.site.deploy.AbstractDeployMojo
-
The current user system settings for use in Maven.
- settingsDecrypter - Variable in class org.apache.maven.plugins.site.deploy.AbstractDeployMojo
- sinks - Variable in class org.apache.maven.plugins.site.render.ReportDocumentRenderer.MultiPageSinkFactory
-
List of sinks (subpages) associated to this report
- sinks() - Method in class org.apache.maven.plugins.site.render.ReportDocumentRenderer.MultiPageSinkFactory
- SITE_RENDERER_KEY - Static variable in class org.apache.maven.plugins.site.run.DoxiaFilter
- SiteDeployMojo - Class in org.apache.maven.plugins.site.deploy
-
Deploys the generated site using wagon supported protocols to the site URL specified in the
<distributionManagement>
section of the POM. - SiteDeployMojo() - Constructor for class org.apache.maven.plugins.site.deploy.SiteDeployMojo
- SiteDescriptorArtifactMetadata - Class in org.apache.maven.plugins.site.descriptor
-
Attach a POM to an artifact.
- SiteDescriptorArtifactMetadata(Artifact, SiteModel, File) - Constructor for class org.apache.maven.plugins.site.descriptor.SiteDescriptorArtifactMetadata
- SiteDescriptorAttachMojo - Class in org.apache.maven.plugins.site.descriptor
-
Adds the site descriptor (
site.xml
) to the list of files to be installed/deployed. - SiteDescriptorAttachMojo() - Constructor for class org.apache.maven.plugins.site.descriptor.SiteDescriptorAttachMojo
- siteDirectory - Variable in class org.apache.maven.plugins.site.descriptor.AbstractSiteDescriptorMojo
-
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). - SiteJarMojo - Class in org.apache.maven.plugins.site.render
-
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.render.SiteJarMojo
- SitemapDocumentRenderer - Class in org.apache.maven.plugins.site.render
-
Renders a sitemap report.
- SitemapDocumentRenderer(MojoExecution, DocumentRenderingContext, String, SiteModel, I18N, Log) - Constructor for class org.apache.maven.plugins.site.render.SitemapDocumentRenderer
- siteModel - Variable in class org.apache.maven.plugins.site.descriptor.SiteDescriptorArtifactMetadata
- siteModel - Variable in class org.apache.maven.plugins.site.render.SitemapDocumentRenderer
- SiteMojo - Class in org.apache.maven.plugins.site.render
-
Generates the site for a single project.
- SiteMojo() - Constructor for class org.apache.maven.plugins.site.render.SiteMojo
- SitePluginReportDocumentRenderer - Interface in org.apache.maven.plugins.site.render
- siteRenderer - Variable in class org.apache.maven.plugins.site.render.AbstractSiteRenderingMojo
-
Site renderer.
- siteRenderer - Variable in class org.apache.maven.plugins.site.run.DoxiaFilter
- SiteRunMojo - Class in org.apache.maven.plugins.site.run
-
Starts the site up, rendering documents as requested for faster editing.
- SiteRunMojo() - Constructor for class org.apache.maven.plugins.site.run.SiteRunMojo
- SiteStageDeployMojo - Class in org.apache.maven.plugins.site.deploy
-
Deploys the generated site to a staging or mock URL to the site URL specified in the
<distributionManagement>
section of the POM, using wagon supported protocols - SiteStageDeployMojo() - Constructor for class org.apache.maven.plugins.site.deploy.SiteStageDeployMojo
- SiteStageMojo - Class in org.apache.maven.plugins.site.deploy
-
Deploys the generated site to 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.deploy.SiteStageMojo
- siteTool - Variable in class org.apache.maven.plugins.site.AbstractSiteMojo
-
SiteTool.
- skip - Variable in class org.apache.maven.plugins.site.AbstractSiteMojo
-
Set this to 'true' to skip site generation and staging.
- skipDeploy - Variable in class org.apache.maven.plugins.site.deploy.AbstractDeployMojo
-
Set this to 'true' to skip site deployment.
- stagingDirectory - Variable in class org.apache.maven.plugins.site.deploy.SiteStageMojo
-
Staging directory location.
- stagingSiteId - Variable in class org.apache.maven.plugins.site.deploy.SiteStageDeployMojo
-
The identifier of the site where the staged site will be deployed.
- stagingSiteURL - Variable in class org.apache.maven.plugins.site.deploy.SiteStageDeployMojo
-
The staged site will be deployed to this URL.
- storedInArtifactVersionDirectory() - Method in class org.apache.maven.plugins.site.descriptor.SiteDescriptorArtifactMetadata
- storeInLocalRepository(ArtifactRepository, ArtifactRepository) - Method in class org.apache.maven.plugins.site.descriptor.SiteDescriptorArtifactMetadata
T
- tempWebappDirectory - Variable in class org.apache.maven.plugins.site.run.SiteRunMojo
-
Where to create the dummy web application.
- title - Variable in class org.apache.maven.plugins.site.render.CategorySummaryDocumentRenderer
- title - Variable in class org.apache.maven.plugins.site.render.SitemapDocumentRenderer
- toLines(String, int, int, int) - Static method in class org.apache.maven.plugins.maven_site_plugin.HelpMojo
-
Splits the specified text into lines of convenient display length.
- toLines(List<String>, String, int, int) - Static method in class org.apache.maven.plugins.maven_site_plugin.HelpMojo
-
Adds the specified line to the output sequence, performing line wrapping if necessary.
- topDistributionManagementSiteUrl - Variable in class org.apache.maven.plugins.site.deploy.AbstractDeployMojo
- topSiteURL - Variable in class org.apache.maven.plugins.site.deploy.AbstractStagingMojo
-
Top distribution management site url, for manual configuration when auto-calculated value doesn't match expectations.
- toString() - Method in class org.apache.maven.plugins.site.descriptor.SiteDescriptorArtifactMetadata
U
- URIEncoder() - Constructor for class org.apache.maven.plugins.site.deploy.AbstractDeployMojo.URIEncoder
V
- validate - Variable in class org.apache.maven.plugins.site.render.SiteMojo
-
Whether to validate xml input documents.
W
- writeComment(XMLWriter, String) - Static method in class org.apache.maven.plugins.site.descriptor.EffectiveSiteMojo
-
Write comments in a normalize way.
- writeEffectiveSite(SiteModel, XMLWriter) - Method in class org.apache.maven.plugins.site.descriptor.EffectiveSiteMojo
- writeGoal(StringBuilder, String, Element) - Method in class org.apache.maven.plugins.maven_site_plugin.HelpMojo
- writeHeader(XMLWriter) - Static method in class org.apache.maven.plugins.site.descriptor.EffectiveSiteMojo
-
Write comments in the Effective POM/settings header.
- writeParameter(StringBuilder, Node, Node) - Method in class org.apache.maven.plugins.maven_site_plugin.HelpMojo
- writeXmlFile(File, String) - Static method in class org.apache.maven.plugins.site.descriptor.EffectiveSiteMojo
All Classes and Interfaces|All Packages|Constant Field Values