org.apache.maven.reporting

接口 MavenReport

所有已知的子接口：

MavenMultiPageReport

public interface MavenReport

Maven 报告的基础。

自从：

2.0

作者：

布雷特·波特，伊曼纽尔·维尼斯，文森特·西维顿

字段摘要

字段

修饰符和类型	字段和说明
static String	CATEGORY_PROJECT_INFORMATION 项目信息报告的类别
static String	CATEGORY_PROJECT_REPORTS 项目报告的类别
static String	ROLE Plexus 查找名称

方法总结

修饰符和类型	方法及说明
boolean	canGenerateReport() 在生成报告之前验证一些条件。
void	generate(Sink sink, Locale locale) 根据所需的语言环境生成报告。
String	getCategoryName() 获取此报告的类别名称。
String	getDescription(Locale locale) 获取本地化的报告描述。
String	getName(Locale locale) 获取本地化的报告名称。
String	getOutputName() 获取用于创建报告输出文件的基本名称。
File	getReportOutputDirectory()
boolean	isExternalReport() 外部报告是调用第三方程序的报告，该程序也生成一些报告。
void	setReportOutputDirectory(File outputDirectory) 设置一个新的输出目录。

字段详细信息

角色

static final String ROLE

Plexus 查找名称

CATEGORY_PROJECT_INFORMATION

static final String CATEGORY_PROJECT_INFORMATION

项目信息报告的类别

也可以看看：

常量字段值

CATEGORY_PROJECT_REPORTS

static final String CATEGORY_PROJECT_REPORTS

项目报告的类别

也可以看看：

常量字段值

方法详情

产生

void generate(Sink sink,
              Locale locale)
       throws MavenReportException

根据所需的语言环境生成报告。
主要用于javadoc之类的外部报表。

参数：

sink- 用于生成的接收器。

locale- 生成报告所需的语言环境，可以为空。

抛出：

MavenReportException- 如果有的话

获取输出名称

String getOutputName()

获取用于创建报告输出文件的基本名称。

回报：

此报告的输出名称。

获取类别名称

String getCategoryName()

获取此报告的类别名称。

回报：

此报告的类别名称。应该是CATEGORY_PROJECT_INFORMATION 或CATEGORY_PROJECT_REPORTS

获取名称

String getName(Locale locale)

获取本地化的报告名称。

参数：

locale- 想要返回报告名称的语言环境，可以为空。

回报：

本报告的名称。

获取描述

String getDescription(Locale locale)

获取本地化的报告描述。

参数：

locale- 想要返回报告描述的语言环境，可以为空。

回报：

本报告的说明。

设置报告输出目录

void setReportOutputDirectory(File outputDirectory)

设置一个新的输出目录。对分期很有用。

参数：

outputDirectory- 新的输出目录

获取报告输出目录

File getReportOutputDirectory()

回报：

当前报告输出目录。

是外部报告

boolean isExternalReport()

外部报告是调用第三方程序的报告，该程序也生成一些报告。一个很好的例子是 javadoc 工具。

回报：

true如果此报告是外部的，false否则。默认应该是false.

可以生成报告

boolean canGenerateReport()

在生成报告之前验证一些条件。

回报：

true如果可以生成此报告，false否则。默认应该是true.