org.apache.maven.reporting

类 AbstractMavenReportRenderer

java.lang.Object

org.apache.maven.reporting.AbstractMavenReportRenderer

所有实现的接口：

MavenReportRenderer

public abstract class AbstractMavenReportRenderer
extends Object
implements MavenReportRenderer

一个管理报告生成的抽象类，有许多帮助方法来简化工作：您只需要实现 getTitle() 和 renderBody()。

TODO稍后创建类似 VelocityMavenReportRenderer 的东西可能是合适的，它可以采用速度模板并通过 Doxia 进行管道传输，而不是像这样编码它们。

自从：

2.0

作者：

杰森·范·齐尔，伊曼纽尔·维尼斯，文森特·西维顿

也可以看看：

getTitle(), renderBody()

字段摘要

字段

修饰符和类型	字段和说明
protected Sink	sink 要使用的电流接收器

构造函数摘要

构造函数

构造函数和描述
AbstractMavenReportRenderer(Sink sink) 默认构造函数。

方法总结

修饰符和类型	方法及说明
protected static String	createLinkPatternedText(String text, String href) 创建由 定义的链接模式文本{text, url}。
protected void	endSection() 包装以当前接收器结尾的部分的便捷方法。
protected void	endTable() 包装以当前接收器结尾的表的便捷方法。
abstract String	getTitle()
protected void	javaScript(String jsCode) 在当前接收器中添加 Javascript 代码的便捷方法。
protected void	link(String href, String name) 在当前接收器中包装链接的便捷方法。
void	linkPatternedText(String text) 在当前链接中包装图案文本的便捷方法。
protected void	paragraph(String paragraph) 在当前接收器中包装段落的便捷方法。
protected static String	propertiesToString(Properties props) Properties将对象显示为逗号分隔的字符串的便捷方法。
void	render()
protected abstract void	renderBody() 呈现报告的正文内容。
protected void	startSection(String name) 在当前接收器中包装部分创建的便捷方法。
protected void	startTable() 在当前接收器中包装表开始的便捷方法。
protected void	startTable(int[] justification, boolean grid) 在当前接收器中包装表开始的便捷方法。
protected void	tableCaption(String caption) 在当前接收器中包装表格标题的便捷方法。
protected void	tableCell(String text) 在当前接收器中包装表格单元格开始的便捷方法。
protected void	tableCell(String text, boolean asHtml) 在当前接收器中包装表格单元格开始的便捷方法。
protected void	tableHeader(String[] content) 在当前接收器中包装表格标题行的便捷方法。
protected void	tableHeaderCell(String text) 将表头单元格开始包装在当前接收器中的便捷方法。
protected void	tableRow(String[] content) 在当前接收器中包装表格行开始的便捷方法。
protected void	text(String text) 在当前接收器中包装文本的便捷方法。
protected void	verbatimLink(String text, String href) 在当前接收器中将具有给定链接 href 的文本包装为逐字样式的便捷方法。
protected void	verbatimText(String text) 在当前接收器中将文本包装为逐字样式的便捷方法。

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

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

字段详细信息

下沉

protected Sink sink

要使用的电流接收器

构造函数详细信息

AbstractMavenReportRenderer

public AbstractMavenReportRenderer(Sink sink)

默认构造函数。

参数：

sink- 使用的水槽。

方法详情

使成为

public void render()

指定者：

render 在界面中 MavenReportRenderer

开始部分

protected void startSection(String name)

在当前接收器中包装部分创建的便捷方法。将为名称添加一个锚点。

参数：

name- 此部分的名称，可以为空。

也可以看看：

text(String), Sink.section1(), Sink.sectionTitle1(), Sink.sectionTitle1_(), Sink.section2(), Sink.sectionTitle2(), Sink.sectionTitle2_(), Sink.section3(), Sink.sectionTitle3(), Sink.sectionTitle3_(), Sink.section4(), Sink.sectionTitle4(), Sink.sectionTitle4_(), Sink.section5(), Sink.sectionTitle5(), Sink.sectionTitle5_()

结束部分

protected void endSection()

包装以当前接收器结尾的部分的便捷方法。

抛出：

IllegalStateException- 如果结束部分太多。

也可以看看：

Sink.section1_(), Sink.section2_(), Sink.section3_(), Sink.section4_(), Sink.section5_()

开始表

protected void startTable()

在当前接收器中包装表开始的便捷方法。

也可以看看：

Sink.table()

开始表

protected void startTable(int[] justification,
                          boolean grid)

在当前接收器中包装表开始的便捷方法。

参数：

justification- 表格单元格的对齐方式。

grid- 是否在单元格周围绘制网格。

自从：

2.1

也可以看看：

Sink.table(), Sink.tableRows(int[],boolean)

茶几

protected void endTable()

包装以当前接收器结尾的表的便捷方法。

也可以看看：

Sink.table_()

表头单元格

protected void tableHeaderCell(String text)

将表头单元格开始包装在当前接收器中的便捷方法。

参数：

text- 放置在此单元格中的文本可以为空。

也可以看看：

text(String), Sink.tableHeaderCell(), Sink.tableHeaderCell_()

表格单元格

protected void tableCell(String text)

在当前接收器中包装表格单元格开始的便捷方法。

文本可以是由以下定义的链接模式文本{text, url}

参数：

text- 放置在此单元格中的文本可以为空。

也可以看看：

linkPatternedText(String), tableCell(String)

表格单元格

protected void tableCell(String text,
                         boolean asHtml)

在当前接收器中包装表格单元格开始的便捷方法。

文本可以是由以下定义的链接模式文本{text, url}

如果asHtml为真，则将文本添加为 Html

参数：

text- 放置在此单元格中的文本可以为空。

asHtml-true将文本添加为 Html，false否则。

也可以看看：

linkPatternedText(String), Sink.tableCell(), Sink.tableCell_(), Sink.rawText(String)

表行

protected void tableRow(String[] content)

在当前接收器中包装表格行开始的便捷方法。

中的文本content可以是由定义的链接模式文本{text, url}

参数：

content- 要放入该行单元格的文本数组，可以为空。

也可以看看：

tableCell(String), Sink.tableRow(), Sink.tableRow_()

表头

protected void tableHeader(String[] content)

在当前接收器中包装表格标题行的便捷方法。

参数：

content- 要放入此行标题中的单元格的文本数组，可以为空。

也可以看看：

tableHeaderCell(String), Sink.tableRow(), Sink.tableRow_()

表格标题

protected void tableCaption(String caption)

在当前接收器中包装表格标题的便捷方法。

参数：

caption- 表格的标题，可以为空。

也可以看看：

text(String), Sink.tableCaption(), Sink.tableCaption_()

段落

protected void paragraph(String paragraph)

在当前接收器中包装段落的便捷方法。

参数：

paragraph- 要添加的段落，可以为空。

也可以看看：

text(String), Sink.paragraph(), Sink.paragraph_()

关联

protected void link(String href,
                    String name)

在当前接收器中包装链接的便捷方法。

参数：

href- 要添加的链接，不能为空。

name- 链接名称。

也可以看看：

text(String), Sink.link(String), Sink.link_()

文本

protected void text(String text)

在当前接收器中包装文本的便捷方法。

如果文本为空或有null值，则添加"-"字符

参数：

text- 文本，可以为空。

也可以看看：

Sink.text(String)

逐字逐句

protected void verbatimText(String text)

在当前接收器中将文本包装为逐字样式的便捷方法。

参数：

text- 文本，可以为空。

也可以看看：

text(String), Sink.verbatim(boolean), Sink.verbatim_()

逐字链接

protected void verbatimLink(String text,
                            String href)

在当前接收器中将具有给定链接 href 的文本包装为逐字样式的便捷方法。

参数：

text- 一个字符串

href- href 可以为空

也可以看看：

link(String, String), verbatimText(String), Sink.verbatim(boolean), Sink.verbatim_()

脚本

protected void javaScript(String jsCode)

在当前接收器中添加 Javascript 代码的便捷方法。

参数：

jsCode- 一串Javascript

也可以看看：

Sink.rawText(String)

链接图案文本

public void linkPatternedText(String text)

在当前链接中包装图案文本的便捷方法。

text 变量应该包含这个给定的模式{text, url} 来处理链接的创建。

参数：

text- 定义了链接模式的文本。

也可以看看：

text(String), link(String, String), applyPattern(String)

createLinkPatternedText

protected static String createLinkPatternedText(String text,
                                                String href)

创建由 定义的链接模式文本{text, url}。

该方法可以使用此创建的模式linkPatternedText(String)来处理带有链接的文本。

参数：

text-

href-

回报：

链接模式

也可以看看：

linkPatternedText(String)

属性到字符串

protected static String propertiesToString(Properties props)

Properties将对象显示为逗号分隔的字符串的便捷方法。

参数：

props- 要显示的属性。

回报：

属性对象为逗号分隔的字符串

获取标题

public abstract String getTitle()

指定者：

getTitle 在界面中 MavenReportRenderer

渲染体

protected abstract void renderBody()

呈现报告的正文内容。