A C D G I M O P R S

A

assembler - Variable in class org.apache.maven.doxia.tools.DefaultSiteTool

The component for assembling inheritance.

C

codeToLocale(String) - Method in class org.apache.maven.doxia.tools.DefaultSiteTool

Converts a locale code like "en", "en_US" or "en_US_win" to a java.util.Locale object.

If localeCode = default, return the current value of the default locale for this instance of the Java Virtual Machine.

codeToLocale(String) - Method in interface org.apache.maven.doxia.tools.SiteTool

Converts a locale code like "en", "en_US" or "en_US_win" to a java.util.Locale object.

compare(Object, Object) - Method in class org.apache.maven.doxia.tools.ReportComparator

D

DEFAULT_LOCALE - Static variable in interface org.apache.maven.doxia.tools.SiteTool

The locale by default for all default bundles

DefaultSiteTool - class org.apache.maven.doxia.tools.DefaultSiteTool.

Default implementation of the site tool.

DefaultSiteTool() - Constructor for class org.apache.maven.doxia.tools.DefaultSiteTool

G

getAvailableLocales(String) - Method in class org.apache.maven.doxia.tools.DefaultSiteTool

Init the localesList variable.

If the locales variable is available, the first valid token will be the defaultLocale for this instance of the Java Virtual Machine.

getAvailableLocales(String) - Method in interface org.apache.maven.doxia.tools.SiteTool

Init the localesList variable.

getDecorationModel(MavenProject, List, ArtifactRepository, List, String, Locale, String, String) - Method in class org.apache.maven.doxia.tools.DefaultSiteTool

Get a decoration model for a project.

getDecorationModel(MavenProject, List, ArtifactRepository, List, String, Locale, String, String) - Method in interface org.apache.maven.doxia.tools.SiteTool

Get a decoration model for a project.

getDefaultSkinArtifact(ArtifactRepository, List) - Method in class org.apache.maven.doxia.tools.DefaultSiteTool

Get the default skin artifact for a project from one of the repositories.

getDefaultSkinArtifact(ArtifactRepository, List) - Method in interface org.apache.maven.doxia.tools.SiteTool

Get the default skin artifact for a project from one of the repositories.

getInterpolatedSiteDescriptorContent(Map, MavenProject, String, String, String) - Method in class org.apache.maven.doxia.tools.DefaultSiteTool

Interpolating several expressions in the site descriptor content. Actually, the expressions could be in the project, the environment variables and the specific properties like encoding.

For instance:

${project.name}

The value from the POM of:

<project>
<name>myProjectName</name>
</project>

${my.value}

The value from the POM of:

<properties>
<my.value>hello</my.value>
</properties>

${JAVA_HOME}

The value of JAVA_HOME in the environment variables

getInterpolatedSiteDescriptorContent(Map, MavenProject, String, String, String) - Method in interface org.apache.maven.doxia.tools.SiteTool

Interpolating several expressions in the site descriptor content.

getNormalizedPath(String) - Static method in class org.apache.maven.doxia.tools.DefaultSiteTool

getParentProject(MavenProject, List, ArtifactRepository) - Method in class org.apache.maven.doxia.tools.DefaultSiteTool

Returns the parent POM with interpolated URLs. Attempts to source this value from the reactorProjects parameters if available (reactor env model attributes are interpolated), or if the reactor is unavailable (-N) resorts to the project.getParent().getUrl() value which will NOT have been interpolated.

TODO: once bug is fixed in Maven proper, remove this.

getParentProject(MavenProject, List, ArtifactRepository) - Method in interface org.apache.maven.doxia.tools.SiteTool

Returns the parent POM with interpolated URLs.

getRelativePath(String, String) - Method in class org.apache.maven.doxia.tools.DefaultSiteTool

Calculate the relative path between two URLs or between two files. For example:

to = "http://maven.apache.org" and from = "http://maven.apache.org"

return ""

to = "http://maven.apache.org" and from = "http://maven.apache.org/plugins/maven-site-plugin/"

return "../.."

to = "http://maven.apache.org/plugins/maven-site-plugin/" and from = "http://maven.apache.org"

return "plugins/maven-site-plugin"

to = "/myproject/myproject-module1" and from = "/myproject/myproject"

return "../myproject-module1"

Note: The file separator depends on the system.

getRelativePath(String, String) - Method in interface org.apache.maven.doxia.tools.SiteTool

Calculate the relative path between two URLs or between two files.

getSiteDescriptorFromBasedir(String, File, Locale) - Method in class org.apache.maven.doxia.tools.DefaultSiteTool

Get a site descriptor from the project's base direcory.

getSiteDescriptorFromBasedir(String, File, Locale) - Method in interface org.apache.maven.doxia.tools.SiteTool

Get a site descriptor from the project's base direcory.

getSiteDescriptorFromRepository(MavenProject, ArtifactRepository, List, Locale) - Method in class org.apache.maven.doxia.tools.DefaultSiteTool

Get a site descriptor from one of the repositories.

getSiteDescriptorFromRepository(MavenProject, ArtifactRepository, List, Locale) - Method in interface org.apache.maven.doxia.tools.SiteTool

Get a site descriptor from one of the repositories.

getSkinArtifactFromRepository(ArtifactRepository, List, DecorationModel) - Method in class org.apache.maven.doxia.tools.DefaultSiteTool

Get a site descriptor defined in the decoration from one of the repositories.

getSkinArtifactFromRepository(ArtifactRepository, List, DecorationModel) - Method in interface org.apache.maven.doxia.tools.SiteTool

Get a site descriptor defined in the decoration from one of the repositories.

I

i18n - Variable in class org.apache.maven.doxia.tools.DefaultSiteTool

Internationalization.

M

mavenProjectBuilder - Variable in class org.apache.maven.doxia.tools.DefaultSiteTool

Project builder.

O

org.apache.maven.doxia.tools - package org.apache.maven.doxia.tools

P

populateModules(MavenProject, List, ArtifactRepository, DecorationModel, Locale, boolean) - Method in class org.apache.maven.doxia.tools.DefaultSiteTool

Populate the modules menu part of the decoration model.

populateModules(MavenProject, List, ArtifactRepository, DecorationModel, Locale, boolean) - Method in interface org.apache.maven.doxia.tools.SiteTool

Populate the modules menu part of the decoration model.

populateProjectParentMenu(DecorationModel, Locale, MavenProject, MavenProject, boolean) - Method in class org.apache.maven.doxia.tools.DefaultSiteTool

Populate the parent menu part of the decoration model.

populateProjectParentMenu(DecorationModel, Locale, MavenProject, MavenProject, boolean) - Method in interface org.apache.maven.doxia.tools.SiteTool

Populate the parent menu part of the decoration model.

populateReportsMenu(DecorationModel, Locale, Map) - Method in class org.apache.maven.doxia.tools.DefaultSiteTool

Populate the report menu part of the decoration model.

populateReportsMenu(DecorationModel, Locale, Map) - Method in interface org.apache.maven.doxia.tools.SiteTool

Populate the report menu part of the decoration model.

R

ROLE - Static variable in interface org.apache.maven.doxia.tools.SiteTool

Plexus Role

ReportComparator - class org.apache.maven.doxia.tools.ReportComparator.

Sorts reports.

ReportComparator(Locale) - Constructor for class org.apache.maven.doxia.tools.ReportComparator

Default constructor.

S

SiteTool - interface org.apache.maven.doxia.tools.SiteTool.

Tool to play with Doxia objects like DecorationModel.

SiteToolException - exception org.apache.maven.doxia.tools.SiteToolException.

An exception occurring during the execution of this tool.

SiteToolException(String, Exception) - Constructor for class org.apache.maven.doxia.tools.SiteToolException

Construct a new SiteToolException exception wrapping an underlying Exception and providing a message.

SiteToolException(String, Throwable) - Constructor for class org.apache.maven.doxia.tools.SiteToolException

Construct a new SiteToolException exception wrapping an underlying Throwable and providing a message.

SiteToolException(String) - Constructor for class org.apache.maven.doxia.tools.SiteToolException

Construct a new SiteToolException exception providing a message.

A C D G I M O P R S