org.apache.maven.reporting

类 AbstractMavenReport

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.reporting.AbstractMavenReport

所有实现的接口：

ContextEnabled , Mojo , MavenMultiPageReport , MavenReport

public abstract class AbstractMavenReport
extends AbstractMojo
implements MavenMultiPageReport

Maven 报告的基础，它既可以作为站点生成的一部分生成，也可以作为直接的独立目标调用生成。两个调用都委托给abstract executeReport( Locale )：

• Mojo的execute()方法，见maven-plugin-api
• MavenMultiPageReport generate( Sink, SinkFactory, Locale )，见 maven-reporting-api

自从：

2.0

作者：

伊曼纽尔·维尼斯

也可以看看：

Mojo.execute(), from maven-plugin-api, MavenMultiPageReport.generate( Sink, SinkFactory, Locale ), from maven-reporting-api, abstract executeReport( Locale )

字段摘要

字段

修饰符和类型	字段和说明
protected File	outputDirectory 报告的输出目录。
protected MavenProject	project Maven 项目。
protected Renderer	siteRenderer Doxia 站点渲染器组件。

从接口 org.apache.maven.reporting 继承的字段。Maven报告

CATEGORY_PROJECT_INFORMATION, CATEGORY_PROJECT_REPORTS, ROLE

从接口 org.apache.maven.plugin 继承的字段。魔精

ROLE

构造函数摘要

构造函数

构造函数和描述
AbstractMavenReport()

方法总结

修饰符和类型	方法及说明
boolean	canGenerateReport()
protected void	closeReport() 关闭报告时的操作。
void	execute() 当报表生成作为独立 Mojo 直接调用时，会调用此方法。
protected abstract void	executeReport(Locale locale) 执行报告的生成。
void	generate(org.codehaus.doxia.sink.Sink sink, Locale locale) 已弃用。 改为使用generate(Sink, SinkFactory, Locale)。
void	generate(Sink sink, Locale locale) 已弃用。 改为使用generate(Sink, SinkFactory, Locale)。
void	generate(Sink sink, SinkFactory sinkFactory, Locale locale) 当 maven-site-plugin 调用报告生成时调用此方法。
String	getCategoryName()
protected String	getInputEncoding() 获取输入文件编码。
protected String	getOutputDirectory()
protected String	getOutputEncoding() 获取有效的报告输出文件编码。
protected MavenProject	getProject()
File	getReportOutputDirectory()
Sink	getSink()
SinkFactory	getSinkFactory()
protected Renderer	getSiteRenderer()
boolean	isExternalReport()
void	setReportOutputDirectory(File reportOutputDirectory)

从类 org.apache.maven.plugin 继承的方法。抽象魔力

getLog, getPluginContext, setLog, setPluginContext

从类 java.lang 继承的方法。目的

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口 org.apache.maven.reporting 继承的方法。Maven报告

getDescription, getName, getOutputName

字段详细信息

输出目录

@Parameter(defaultValue="${project.reporting.outputDirectory}",
           readonly=true,
           required=true)
protected File outputDirectory

报告的输出目录。请注意，仅当直接从命令行运行目标时才会评估此参数。如果目标作为站点生成的一部分间接运行，则使用在 Maven 站点插件中配置的输出目录。

项目

@Parameter(defaultValue="${project}",
           readonly=true,
           required=true)
protected MavenProject project

Maven 项目。

站点渲染器

@Component
protected Renderer siteRenderer

Doxia 站点渲染器组件。

构造函数详细信息

摘要Maven报告

public AbstractMavenReport()

方法详情

执行

public void execute()
             throws MojoExecutionException

当报表生成作为独立 Mojo 直接调用时，会调用此方法。

指定者：

execute 在界面中 Mojo

抛出：

MojoExecutionException- 如果生成报告时发生错误

也可以看看：

Mojo.execute()

产生

@Deprecated
public void generate(org.codehaus.doxia.sink.Sink sink,
                                  Locale locale)
                           throws MavenReportException

已弃用。 改为使用generate(Sink, SinkFactory, Locale)。

生成报告。

参数：

sink- 用于生成的接收器。

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

抛出：

MavenReportException- 如果有的话

产生

@Deprecated
public void generate(Sink sink,
                                  Locale locale)
                           throws MavenReportException

已弃用。 改为使用generate(Sink, SinkFactory, Locale)。

生成报告。

指定者：

generate 在界面中 MavenReport

参数：

sink-

locale-

抛出：

MavenReportException

产生

public void generate(Sink sink,
                     SinkFactory sinkFactory,
                     Locale locale)
              throws MavenReportException

当 maven-site-plugin 调用报告生成时调用此方法。

指定者：

generate 在界面中 MavenMultiPageReport

参数：

sink-

sinkFactory-

locale-

抛出：

MavenReportException

获取类别名称

public String getCategoryName()

指定者：

getCategoryName 在界面中 MavenReport

回报：

CATEGORY_PROJECT_REPORTS

获取报告输出目录

public File getReportOutputDirectory()

指定者：

getReportOutputDirectory 在界面中 MavenReport

设置报告输出目录

public void setReportOutputDirectory(File reportOutputDirectory)

指定者：

setReportOutputDirectory 在界面中 MavenReport

获取输出目录

protected String getOutputDirectory()

获取项目

protected MavenProject getProject()

获取站点渲染器

protected Renderer getSiteRenderer()

获取输入编码

protected String getInputEncoding()

获取输入文件编码。

回报：

输入文件编码，从不null.

获取输出编码

protected String getOutputEncoding()

获取有效的报告输出文件编码。

回报：

有效的报告输出文件编码，从不null.

关闭报告

protected void closeReport()

关闭报告时的操作。

接收器

public Sink getSink()

回报：

使用的水槽

获取SinkFactory

public SinkFactory getSinkFactory()

回报：

使用的水槽工厂

是外部报告

public boolean isExternalReport()

指定者：

isExternalReport 在界面中 MavenReport

回报：

false默认。

也可以看看：

MavenReport.isExternalReport()

可以生成报告

public boolean canGenerateReport()

指定者：

canGenerateReport 在界面中 MavenReport

执行报告

protected abstract void executeReport(Locale locale)
                               throws MavenReportException

执行报告的生成。

参数：

locale- 想要返回报告描述的语言环境，可以是null.

抛出：

MavenReportException- 如果有的话