|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.codehaus.plexus.logging.AbstractLogEnabled
org.apache.maven.doxia.tools.DefaultSiteTool
public class DefaultSiteTool
Default implementation of the site tool.
Field Summary | |
---|---|
protected org.apache.maven.doxia.site.decoration.inheritance.DecorationModelInheritanceAssembler |
assembler
The component for assembling inheritance. |
protected org.codehaus.plexus.i18n.I18N |
i18n
Internationalization. |
protected org.apache.maven.project.MavenProjectBuilder |
mavenProjectBuilder
Project builder. |
Fields inherited from interface org.apache.maven.doxia.tools.SiteTool |
---|
DEFAULT_LOCALE, ROLE |
Constructor Summary | |
---|---|
DefaultSiteTool()
|
Method Summary | |
---|---|
java.util.Locale |
codeToLocale(java.lang.String localeCode)
Converts a locale code like "en", "en_US" or "en_US_win" to a java.util.Locale
object. |
java.util.List |
getAvailableLocales(java.lang.String locales)
Init the localesList variable. |
org.apache.maven.doxia.site.decoration.DecorationModel |
getDecorationModel(org.apache.maven.project.MavenProject project,
java.util.List reactorProjects,
org.apache.maven.artifact.repository.ArtifactRepository localRepository,
java.util.List repositories,
java.lang.String siteDirectory,
java.util.Locale locale,
java.lang.String inputEncoding,
java.lang.String outputEncoding)
Get a decoration model for a project. |
org.apache.maven.artifact.Artifact |
getDefaultSkinArtifact(org.apache.maven.artifact.repository.ArtifactRepository localRepository,
java.util.List remoteArtifactRepositories)
Get the default skin artifact for a project from one of the repositories. |
java.lang.String |
getInterpolatedSiteDescriptorContent(java.util.Map props,
org.apache.maven.project.MavenProject project,
java.lang.String siteDescriptorContent,
java.lang.String inputEncoding,
java.lang.String outputEncoding)
Interpolating several expressions in the site descriptor content. |
protected static java.lang.String |
getNormalizedPath(java.lang.String path)
|
org.apache.maven.project.MavenProject |
getParentProject(org.apache.maven.project.MavenProject project,
java.util.List reactorProjects,
org.apache.maven.artifact.repository.ArtifactRepository localRepository)
Returns the parent POM with interpolated URLs. |
java.lang.String |
getRelativePath(java.lang.String to,
java.lang.String from)
Calculate the relative path between two URLs or between two files. |
java.io.File |
getSiteDescriptorFromBasedir(java.lang.String siteDirectory,
java.io.File basedir,
java.util.Locale locale)
Get a site descriptor from the project's base direcory. |
java.io.File |
getSiteDescriptorFromRepository(org.apache.maven.project.MavenProject project,
org.apache.maven.artifact.repository.ArtifactRepository localRepository,
java.util.List remoteArtifactRepositories,
java.util.Locale locale)
Get a site descriptor from one of the repositories. |
org.apache.maven.artifact.Artifact |
getSkinArtifactFromRepository(org.apache.maven.artifact.repository.ArtifactRepository localRepository,
java.util.List remoteArtifactRepositories,
org.apache.maven.doxia.site.decoration.DecorationModel decoration)
Get a site descriptor defined in the decoration from one of the repositories. |
void |
populateModules(org.apache.maven.project.MavenProject project,
java.util.List reactorProjects,
org.apache.maven.artifact.repository.ArtifactRepository localRepository,
org.apache.maven.doxia.site.decoration.DecorationModel decorationModel,
java.util.Locale locale,
boolean keepInheritedRefs)
Populate the modules menu part of the decoration model. |
void |
populateProjectParentMenu(org.apache.maven.doxia.site.decoration.DecorationModel decorationModel,
java.util.Locale locale,
org.apache.maven.project.MavenProject project,
org.apache.maven.project.MavenProject parentProject,
boolean keepInheritedRefs)
Populate the parent menu part of the decoration model. |
void |
populateReportsMenu(org.apache.maven.doxia.site.decoration.DecorationModel decorationModel,
java.util.Locale locale,
java.util.Map categories)
Populate the report menu part of the decoration model. |
Methods inherited from class org.codehaus.plexus.logging.AbstractLogEnabled |
---|
enableLogging, getLogger, setupLogger, setupLogger, setupLogger |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected org.codehaus.plexus.i18n.I18N i18n
protected org.apache.maven.doxia.site.decoration.inheritance.DecorationModelInheritanceAssembler assembler
protected org.apache.maven.project.MavenProjectBuilder mavenProjectBuilder
Constructor Detail |
---|
public DefaultSiteTool()
Method Detail |
---|
public org.apache.maven.artifact.Artifact getSkinArtifactFromRepository(org.apache.maven.artifact.repository.ArtifactRepository localRepository, java.util.List remoteArtifactRepositories, org.apache.maven.doxia.site.decoration.DecorationModel decoration) throws SiteToolException
getSkinArtifactFromRepository
in interface SiteTool
localRepository
- the Maven local repository, not null.remoteArtifactRepositories
- the Maven remote repositories, not null.decoration
- the Doxia site descriptor model, not null.
Skin
artifact defined in a DecorationModel
from a given project and a
local repository
SiteToolException
- if anypublic org.apache.maven.artifact.Artifact getDefaultSkinArtifact(org.apache.maven.artifact.repository.ArtifactRepository localRepository, java.util.List remoteArtifactRepositories) throws SiteToolException
getDefaultSkinArtifact
in interface SiteTool
localRepository
- the Maven local repository, not null.remoteArtifactRepositories
- the Maven remote repositories, not null.
Skin
artifact from a given project and a local repository
SiteToolException
- if anySkin.getDefaultSkin()
,
SiteTool.getSkinArtifactFromRepository(ArtifactRepository, List, DecorationModel)
public java.lang.String getRelativePath(java.lang.String to, java.lang.String from)
getRelativePath
in interface SiteTool
to
- the to
url of file as stringfrom
- the from
url of file as string
from
to to
.public java.io.File getSiteDescriptorFromBasedir(java.lang.String siteDirectory, java.io.File basedir, java.util.Locale locale)
getSiteDescriptorFromBasedir
in interface SiteTool
siteDirectory
- The path to the directory containing the site.xml
file, relative to the
project base directory. If null, using by default "src/site".basedir
- not null.locale
- the locale wanted for the site descriptor. If not null, searching for
site_localeLanguage.xml
, otherwise searching for site.xml
.
src/site/site.xml
, depending on parameter values.public java.io.File getSiteDescriptorFromRepository(org.apache.maven.project.MavenProject project, org.apache.maven.artifact.repository.ArtifactRepository localRepository, java.util.List remoteArtifactRepositories, java.util.Locale locale) throws SiteToolException
getSiteDescriptorFromRepository
in interface SiteTool
project
- the Maven project, not null.localRepository
- the Maven local repository, not null.remoteArtifactRepositories
- the Maven remote repositories, not null.locale
- the locale wanted for the site descriptor. If not null, searching for
site_localeLanguage.xml
, otherwise searching for site.xml
.
SiteToolException
- if anypublic org.apache.maven.doxia.site.decoration.DecorationModel getDecorationModel(org.apache.maven.project.MavenProject project, java.util.List reactorProjects, org.apache.maven.artifact.repository.ArtifactRepository localRepository, java.util.List repositories, java.lang.String siteDirectory, java.util.Locale locale, java.lang.String inputEncoding, java.lang.String outputEncoding) throws SiteToolException
getDecorationModel
in interface SiteTool
project
- the Maven project, not null.reactorProjects
- the Maven reactor projects, not null.localRepository
- the Maven local repository, not null.repositories
- the Maven remote repositories, not null.siteDirectory
- The path to the directory containing the site.xml
file, relative to the
project base directory. If null, using by default "src/site".locale
- the locale used for the i18n in DecorationModel. If null, using the default locale in the jvm.inputEncoding
- the input encoding of the site descriptor, not null.outputEncoding
- the output encoding wanted, not null.
DecorationModel
object corresponding to the site.xml
file with some
interpolations.
SiteToolException
- if anypublic void populateReportsMenu(org.apache.maven.doxia.site.decoration.DecorationModel decorationModel, java.util.Locale locale, java.util.Map categories)
populateReportsMenu
in interface SiteTool
decorationModel
- the Doxia DecorationModel, not null.locale
- the locale used for the i18n in DecorationModel. If null, using the default locale in the jvm.categories
- a map to put on the decoration model, not null.public java.lang.String getInterpolatedSiteDescriptorContent(java.util.Map props, org.apache.maven.project.MavenProject project, java.lang.String siteDescriptorContent, java.lang.String inputEncoding, java.lang.String outputEncoding) throws SiteToolException
encoding
.
For instance:
<project>
<name>myProjectName</name>
</project>
<properties>
<my.value>hello</my.value>
</properties>
getInterpolatedSiteDescriptorContent
in interface SiteTool
props
- a map used for interpolation, not null.project
- a Maven project, not null.siteDescriptorContent
- the site descriptor file, not null.inputEncoding
- the input encoding of the site descriptor, not null.outputEncoding
- the output encoding wanted, not null.
site.xml
file with interpolated strings.
SiteToolException
- if errors happened during the interpolation.public org.apache.maven.project.MavenProject getParentProject(org.apache.maven.project.MavenProject project, java.util.List reactorProjects, org.apache.maven.artifact.repository.ArtifactRepository localRepository)
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
in interface SiteTool
project
- a Maven project, not null.reactorProjects
- the Maven reactor projects, not null.localRepository
- the Maven local repository, not null.
public void populateProjectParentMenu(org.apache.maven.doxia.site.decoration.DecorationModel decorationModel, java.util.Locale locale, org.apache.maven.project.MavenProject project, org.apache.maven.project.MavenProject parentProject, boolean keepInheritedRefs)
populateProjectParentMenu
in interface SiteTool
decorationModel
- the Doxia DecorationModel, not null.locale
- the locale used for the i18n in DecorationModel. If null, using the default locale in the jvm.project
- a Maven project, not null.parentProject
- a Maven parent project, not null.keepInheritedRefs
- used for inherited references.public void populateModules(org.apache.maven.project.MavenProject project, java.util.List reactorProjects, org.apache.maven.artifact.repository.ArtifactRepository localRepository, org.apache.maven.doxia.site.decoration.DecorationModel decorationModel, java.util.Locale locale, boolean keepInheritedRefs) throws SiteToolException
populateModules
in interface SiteTool
project
- a Maven project, not null.reactorProjects
- the Maven reactor projects, not null.localRepository
- the Maven local repository, not null.decorationModel
- the Doxia site descriptor model, not null.locale
- the locale used for the i18n in DecorationModel. If null, using the default locale in the jvm.keepInheritedRefs
- used for inherited references.
SiteToolException
- if anypublic java.util.List getAvailableLocales(java.lang.String locales)
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
in interface SiteTool
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.
Locale
public java.util.Locale codeToLocale(java.lang.String localeCode)
java.util.Locale
object.
If localeCode = default
, return the current value of the default locale for this instance
of the Java Virtual Machine.
codeToLocale
in interface SiteTool
localeCode
- the locale code string.
protected static java.lang.String getNormalizedPath(java.lang.String path)
path
- could be null.
FilenameUtils.normalize(String)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |