包裹   班级  采用  树  已弃用  指数  帮助 
 上一课   下一课 框架    没有框架    所有类
摘要：嵌套 | 领域 | 构造 | 方法 详细信息： 字段 | 构造 | 方法

org.apache.maven.doxia.tools
接口 SiteTool

所有已知的实现类：
默认站点工具
public interface SiteTool

玩Doxia对象的工具，例如DecorationModel.

版本：
$Id：SiteTool.java 1098159 2011-04-30 21:07:49Z 丹尼斯 $
作者：
文森特·西维顿

字段摘要
static Locale DEFAULT_LOCALE
          所有默认捆绑包的默认语言环境
static String ROLE
          丛角色
 
方法总结
 Locale codeToLocale(String localeCode)
          将诸如“en”、“en_US”或“en_US_win”之类的语言环境代码转换为java.util.Locale 对象。
 List<Locale> getAvailableLocales(String locales)
          初始化localesList变量。
 org.apache.maven.doxia.site.decoration.DecorationModel getDecorationModel(org.apache.maven.project.MavenProject project, List<org.apache.maven.project.MavenProject> reactorProjects, org.apache.maven.artifact.repository.ArtifactRepository localRepository, List<org.apache.maven.artifact.repository.ArtifactRepository> repositories, String siteDirectory, Locale locale, String inputEncoding, String outputEncoding)
          获取项目的装饰模型。
 org.apache.maven.artifact.Artifact getDefaultSkinArtifact(org.apache.maven.artifact.repository.ArtifactRepository localRepository, List<org.apache.maven.artifact.repository.ArtifactRepository> remoteArtifactRepositories)
          从存储库之一获取项目的默认皮肤工件。
 String getInterpolatedSiteDescriptorContent(Map<String,String> props, org.apache.maven.project.MavenProject aProject, String siteDescriptorContent, String inputEncoding, String outputEncoding)
          在站点描述符内容中插入多个表达式。
 org.apache.maven.project.MavenProject getParentProject(org.apache.maven.project.MavenProject aProject, List<org.apache.maven.project.MavenProject> reactorProjects, org.apache.maven.artifact.repository.ArtifactRepository localRepository)
          返回带有插值 URL 的父 POM。
 String getRelativePath(String to, String from)
          计算两个 URL 之间或两个文件之间的相对路径。
 File getSiteDescriptorFromBasedir(String siteDirectory, File basedir, Locale locale)
          从项目的基本目录中获取站点描述符。
 File getSiteDescriptorFromRepository(org.apache.maven.project.MavenProject project, org.apache.maven.artifact.repository.ArtifactRepository localRepository, List<org.apache.maven.artifact.repository.ArtifactRepository> repositories, Locale locale)
          从其中一个存储库中获取站点描述符。
 org.apache.maven.artifact.Artifact getSkinArtifactFromRepository(org.apache.maven.artifact.repository.ArtifactRepository localRepository, List<org.apache.maven.artifact.repository.ArtifactRepository> remoteArtifactRepositories, org.apache.maven.doxia.site.decoration.DecorationModel decoration)
          从其中一个存储库中获取皮肤工件。
 void populateModules(org.apache.maven.project.MavenProject project, List<org.apache.maven.project.MavenProject> reactorProjects, org.apache.maven.artifact.repository.ArtifactRepository localRepository, org.apache.maven.doxia.site.decoration.DecorationModel decorationModel, Locale locale, boolean keepInheritedRefs)
          已弃用。 请 populateModulesMenu(MavenProject, List, ArtifactRepository, DecorationModel, Locale, boolean) 改用
 void populateModulesMenu(org.apache.maven.project.MavenProject project, List<org.apache.maven.project.MavenProject> reactorProjects, org.apache.maven.artifact.repository.ArtifactRepository localRepository, org.apache.maven.doxia.site.decoration.DecorationModel decorationModel, Locale locale, boolean keepInheritedRefs)
          填充装饰模型的模块菜单部分。
 void populateParentMenu(org.apache.maven.doxia.site.decoration.DecorationModel decorationModel, Locale locale, org.apache.maven.project.MavenProject project, org.apache.maven.project.MavenProject parentProject, boolean keepInheritedRefs)
          填充装饰模型的父菜单部分。
 void populateProjectParentMenu(org.apache.maven.doxia.site.decoration.DecorationModel decorationModel, Locale locale, org.apache.maven.project.MavenProject project, org.apache.maven.project.MavenProject parentProject, boolean keepInheritedRefs)
          已弃用。 请 populateParentMenu(DecorationModel, Locale, MavenProject, MavenProject, boolean)改用
 void populateReportsMenu(org.apache.maven.doxia.site.decoration.DecorationModel decorationModel, Locale locale, Map<String,List<org.apache.maven.reporting.MavenReport>> categories)
          填充装饰模型的报告菜单部分。
 

字段详细信息

角色

static final String ROLE
丛角色

DEFAULT_LOCALE

static final Locale DEFAULT_LOCALE
所有默认捆绑包的默认语言环境

也可以看看：
Locale.ENGLISH
方法详情

getSkinArtifactFromRepository

org.apache.maven.artifact.Artifact getSkinArtifactFromRepository(org.apache.maven.artifact.repository.ArtifactRepository localRepository,
                                                                 List<org.apache.maven.artifact.repository.ArtifactRepository> remoteArtifactRepositories,
                                                                 org.apache.maven.doxia.site.decoration.DecorationModel decoration)
                                                                 throws SiteToolException
从其中一个存储库中获取皮肤工件。

参数：
localRepository- Maven 本地存储库，不为空。
remoteArtifactRepositories- Maven 远程存储库，不为空。
decoration- Doxia 站点描述符模型，不为空。
回报：
在给定项目和本地存储库 中定义的Skin工件DecorationModel
抛出：
SiteToolException- 如果有的话

getDefaultSkinArtifact

org.apache.maven.artifact.Artifact getDefaultSkinArtifact(org.apache.maven.artifact.repository.ArtifactRepository localRepository,
                                                          List<org.apache.maven.artifact.repository.ArtifactRepository> remoteArtifactRepositories)
                                                          throws SiteToolException
从存储库之一获取项目的默认皮肤工件。

参数：
localRepository- Maven 本地存储库，不为空。
remoteArtifactRepositories- Maven 远程存储库，不为空。
回报：
Skin来自给定项目和本地存储库 的默认工件
抛出：
SiteToolException- 如果有的话
也可以看看：
Skin.getDefaultSkin(), getSkinArtifactFromRepository(ArtifactRepository, List, DecorationModel)

获取相对路径

String getRelativePath(String to,
                       String from)
计算两个 URL 之间或两个文件之间的相对路径。例如：
to = "http://maven.apache.org" 和 from = "http://maven.apache.org"
返回 ””
to = "http://maven.apache.org" 和 from = "http://maven.apache.org/plugins/maven-site-plugin/"
返回 ”../..”
to = "http://maven.apache.org/plugins/maven-site-plugin/" 和 from = "http://maven.apache.org"
返回“插件/maven-site-plugin”
to = "/myproject/myproject-module1" 和 from = "/myproject/myproject"
返回“../myproject-module1”
注意：文件分隔符取决于系统。

参数：
to-to文件的 url 作为字符串
from-from文件的 url 作为字符串
回报：
from从到的相对路径to。

getSiteDescriptorFromBasedir

File getSiteDescriptorFromBasedir(String siteDirectory,
                                  File basedir,
                                  Locale locale)
从项目的基本目录中获取站点描述符。

参数：
siteDirectory- 包含文件的目录的路径site.xml，相对于项目基目录。如果为 null，则默认使用“src/site”。
basedir- 不为空。
locale- 站点描述符所需的语言环境。如果不为空，则搜索 ，否则搜索。 site_localeLanguage.xmlsite.xml
回报：
站点描述符相关文件，即src/site/site.xml，取决于参数值。

getSiteDescriptorFromRepository

File getSiteDescriptorFromRepository(org.apache.maven.project.MavenProject project,
                                     org.apache.maven.artifact.repository.ArtifactRepository localRepository,
                                     List<org.apache.maven.artifact.repository.ArtifactRepository> repositories,
                                     Locale locale)
                                     throws SiteToolException
从其中一个存储库中获取站点描述符。

参数：
project- Maven 项目，不为空。
localRepository- Maven 本地存储库，不为空。
repositories- Maven 远程存储库，不为空。
locale- 站点描述符所需的语言环境。如果不为空，则搜索 ，否则搜索。 site_localeLanguage.xmlsite.xml
回报：
从存储库下载站点描述符后将站点描述符放入本地存储库，如果在存储库中找不到，则返回 null。
抛出：
SiteToolException- 如果有的话

获取装饰模型

org.apache.maven.doxia.site.decoration.DecorationModel getDecorationModel(org.apache.maven.project.MavenProject project,
                                                                          List<org.apache.maven.project.MavenProject> reactorProjects,
                                                                          org.apache.maven.artifact.repository.ArtifactRepository localRepository,
                                                                          List<org.apache.maven.artifact.repository.ArtifactRepository> repositories,
                                                                          String siteDirectory,
                                                                          Locale locale,
                                                                          String inputEncoding,
                                                                          String outputEncoding)
                                                                          throws SiteToolException
获取项目的装饰模型。

参数：
project- Maven 项目，不为空。
reactorProjects- Maven 反应器项目，不为空。
localRepository- Maven 本地存储库，不为空。
repositories- Maven 远程存储库，不为空。
siteDirectory- 包含文件的目录的路径site.xml，相对于项目基目录。如果为 null，则默认使用“src/site”。
locale- 用于装饰模型中 i18n 的语言环境。如果为 null，则使用 jvm 中的默认语言环境。
inputEncoding- 站点描述符的输入编码，不为空。
outputEncoding- 想要的输出编码，不为空。
回报：
与带有一些插值 DecorationModel的文件对应的对象。site.xml
抛出：
SiteToolException- 如果有的话

填充报告菜单

void populateReportsMenu(org.apache.maven.doxia.site.decoration.DecorationModel decorationModel,
                         Locale locale,
                         Map<String,List<org.apache.maven.reporting.MavenReport>> categories)
填充装饰模型的报告菜单部分。

参数：
decorationModel- Doxia 装饰模型，不为空。
locale- 用于装饰模型中 i18n 的语言环境。如果为 null，则使用 jvm 中的默认语言环境。
categories- 放置在装饰模型上的地图，不为空。

getInterpolatedSiteDescriptorContent

String getInterpolatedSiteDescriptorContent(Map<String,String> props,
                                            org.apache.maven.project.MavenProject aProject,
                                            String siteDescriptorContent,
                                            String inputEncoding,
                                            String outputEncoding)
                                            throws SiteToolException
在站点描述符内容中插入多个表达式。实际上，表达式可以在项目、环境变量和特定属性中，如encoding.

例如：

${项目名称}
来自 POM 的值：

<项目>
  <名称>我的项目名称</名称>
</项目>

${我的价值}
来自 POM 的值：

<properties>
  <my.value>你好</my.value>
</properties>

${JAVA_HOME}
环境变量中JAVA_HOME的值

参数：
props- 用于插值的地图，不为空。
aProject- 一个 Maven 项目，不为空。
inputEncoding- 站点描述符的输入编码，不为空。
outputEncoding- 想要的输出编码，不为空。
siteDescriptorContent- 站点描述符文件，不为空。
回报：
基于site.xml带有内插字符串的文件的站点描述符内容。
抛出：
SiteToolException- 如果在插值过程中发生错误。

获取父项目

org.apache.maven.project.MavenProject getParentProject(org.apache.maven.project.MavenProject aProject,
                                                       List<org.apache.maven.project.MavenProject> reactorProjects,
                                                       org.apache.maven.artifact.repository.ArtifactRepository localRepository)
返回带有插值 URL 的父 POM。reactorProjects如果可用（内插反应器环境模型属性）或如果反应器不可用（-N） 尝试从参数中获取此值， 则使用project.getParent().getUrl()不会被内插的值。

TODO：一旦在 Maven 中正确修复了错误，就删除它。

参数：
aProject- 一个 Maven 项目，不为空。
reactorProjects- Maven 反应器项目，不为空。
localRepository- Maven 本地存储库，不为空。
回报：
具有插值 URL 的父项目。

填充父菜单

void populateParentMenu(org.apache.maven.doxia.site.decoration.DecorationModel decorationModel,
                        Locale locale,
                        org.apache.maven.project.MavenProject project,
                        org.apache.maven.project.MavenProject parentProject,
                        boolean keepInheritedRefs)
填充装饰模型的父菜单部分。

参数：
decorationModel- Doxia 装饰模型，不为空。
locale- 用于装饰模型中 i18n 的语言环境。如果为 null，则使用 jvm 中的默认语言环境。
project- 一个 Maven 项目，不为空。
parentProject- 一个 Maven 父项目，不为空。
keepInheritedRefs- 用于继承的引用。

填充项目父菜单

void populateProjectParentMenu(org.apache.maven.doxia.site.decoration.DecorationModel decorationModel,
                               Locale locale,
                               org.apache.maven.project.MavenProject project,
                               org.apache.maven.project.MavenProject parentProject,
                               boolean keepInheritedRefs)
已弃用。 请 populateParentMenu(DecorationModel, Locale, MavenProject, MavenProject, boolean)改用

填充装饰模型的父菜单部分。

参数：
decorationModel- Doxia 装饰模型，不为空。
locale- 用于装饰模型中 i18n 的语言环境。如果为 null，则使用 jvm 中的默认语言环境。
project- 一个 Maven 项目，不为空。
parentProject- 一个 Maven 父项目，不为空。
keepInheritedRefs- 用于继承的引用。

填充模块

void populateModules(org.apache.maven.project.MavenProject project,
                     List<org.apache.maven.project.MavenProject> reactorProjects,
                     org.apache.maven.artifact.repository.ArtifactRepository localRepository,
                     org.apache.maven.doxia.site.decoration.DecorationModel decorationModel,
                     Locale locale,
                     boolean keepInheritedRefs)
                     throws SiteToolException
已弃用。 请 populateModulesMenu(MavenProject, List, ArtifactRepository, DecorationModel, Locale, boolean) 改用

填充装饰模型的模块菜单部分。

参数：
project- 一个 Maven 项目，不为空。
reactorProjects- Maven 反应器项目，不为空。
localRepository- Maven 本地存储库，不为空。
decorationModel- Doxia 站点描述符模型，不为空。
locale- 用于装饰模型中 i18n 的语言环境。如果为 null，则使用 jvm 中的默认语言环境。
keepInheritedRefs- 用于继承的引用。
抛出：
SiteToolException- 如果有的话

填充模块菜单

void populateModulesMenu(org.apache.maven.project.MavenProject project,
                         List<org.apache.maven.project.MavenProject> reactorProjects,
                         org.apache.maven.artifact.repository.ArtifactRepository localRepository,
                         org.apache.maven.doxia.site.decoration.DecorationModel decorationModel,
                         Locale locale,
                         boolean keepInheritedRefs)
                         throws SiteToolException
填充装饰模型的模块菜单部分。

参数：
project- 一个 Maven 项目，不为空。
reactorProjects- Maven 反应器项目，不为空。
localRepository- Maven 本地存储库，不为空。
decorationModel- Doxia 站点描述符模型，不为空。
locale- 用于装饰模型中 i18n 的语言环境。如果为 null，则使用 jvm 中的默认语言环境。
keepInheritedRefs- 用于继承的引用。
抛出：
SiteToolException- 如果有的话

getAvailableLocales

List<Locale> getAvailableLocales(String locales)
初始化localesList变量。

如果locales变量可用，则第一个有效标记将是 defaultLocaleJava 虚拟机的此实例。

参数：
locales- Maven 支持的以逗号分隔的语言环境列表。第一个有效令牌将是此 Java 虚拟机实例的默认语言环境。
回报：
的列表Locale

codeToLocale

Locale codeToLocale(String localeCode)
将诸如“en”、“en_US”或“en_US_win”之类的语言环境代码转换为java.util.Locale 对象。

如果 localeCode = default，则返回此 Java 虚拟机实例的默认语言环境的当前值。

参数：
localeCode- 语言环境代码字符串。
回报：
一个 java.util.Locale 对象实例化或 null 如果发生错误
也可以看看：
java.util.Locale#getDefault()
包裹   班级  采用  树  已弃用  指数  帮助 
 上一课   下一课 框架    没有框架    所有类
摘要：嵌套 | 领域 | 构造 | 方法 详细信息： 字段 | 构造 | 方法
版权所有 © 2002-2011 Apache 软件基金会。版权所有。