org.opencms.report

类 CmsPrintStreamReport

java.lang.Object

org.opencms.report.A_CmsReport

org.opencms.report.CmsHtmlReport

org.opencms.report.CmsPrintStreamReport

所有已实现的接口:

I_CmsReport

直接已知子类:

CmsPublishReport, CmsShellReport

public class CmsPrintStreamReport
extends CmsHtmlReport

Stream report where the output is streamed to the given print stream instance.

Keep in mind that you are resposible for closing the stream calling the close() method when the report is no longer used.

从以下版本开始:

6.5.5

字段概要

从类继承的字段 org.opencms.report.CmsHtmlReport

LINEBREAK, LINEBREAK_TRADITIONAL

从接口继承的字段 org.opencms.report.I_CmsReport

FORMAT_DEFAULT, FORMAT_ERROR, FORMAT_HEADLINE, FORMAT_NOTE, FORMAT_OK, FORMAT_WARNING, REPORT_TYPE_EXTENDED, REPORT_TYPE_SIMPLE

构造器概要

构造器

构造器和说明
CmsPrintStreamReport(java.io.PrintStream printStream, java.util.Locale locale, boolean writeHtml) Constructs a new report using the provided locale for the output language.

方法概要

方法

限定符和类型	方法和说明
void	close() Closes the print stream.
void	finish() Finishes the report, closing the stream.
protected java.lang.String	getLineBreak() Returns the correct line break notation depending on the output style of this report.
java.lang.String	getReportUpdate() Updates this report, this processes all new output added since the last call to this method.
void	print(java.lang.String value, int format) Prints a String to the report, using the indicated formatting.
void	println() Adds a line break to the report.
void	println(java.lang.Throwable t) Adds an Exception to the report, ensuring that the Exception content is processed to generate a valid output esp. for HTML pages.
void	start() Starts the report.

从类继承的方法 org.opencms.report.CmsHtmlReport

isWriteHtml

从类继承的方法 org.opencms.report.A_CmsReport

addError, addWarning, formatRuntime, getErrors, getLastEntryTime, getLocale, getMessages, getRuntime, getSiteRoot, getWarnings, hasError, hasWarning, init, print, print, print, println, println, println, println, printMessageWithParam, printMessageWithParam, removeSiteRoot, resetRuntime, setLastEntryTime

从类继承的方法 java.lang.Object

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

构造器详细资料

CmsPrintStreamReport

public CmsPrintStreamReport(java.io.PrintStream printStream,
                    java.util.Locale locale,
                    boolean writeHtml)

Constructs a new report using the provided locale for the output language.

参数:

printStream - the print stream to write the output to

locale - the locale to use for the output language

writeHtml - decides if the report should write clear text or html code

方法详细资料

close

public void close()

Closes the print stream.

Has to be called after the report has finished.

finish

public void finish()

Finishes the report, closing the stream.

getReportUpdate

public java.lang.String getReportUpdate()

从接口复制的说明: I_CmsReport

Updates this report, this processes all new output added since the last call to this method.

This is only required in case the output is written to a HTML page, if the shell output is used, this will just return an empty String.

指定者:

getReportUpdate 在接口中 I_CmsReport

覆盖:

getReportUpdate 在类中 CmsHtmlReport

返回:

new elements that have been added to the report and not yet processed.

另请参阅:

I_CmsReport.getReportUpdate()

print

public void print(java.lang.String value,
         int format)

从类复制的说明: A_CmsReport

Prints a String to the report, using the indicated formatting.

Use the constants starting with FORMAT from this interface to indicate which formatting to use.

覆盖:

print 在类中 CmsHtmlReport

参数:

value - the message container to add

format - the formatting to use for the output

另请参阅:

A_CmsReport.print(java.lang.String, int)

println

public void println()

从接口复制的说明: I_CmsReport

Adds a line break to the report.

指定者:

println 在接口中 I_CmsReport

覆盖:

println 在类中 CmsHtmlReport

另请参阅:

I_CmsReport.println()

println

public void println(java.lang.Throwable t)

从接口复制的说明: I_CmsReport

Adds an Exception to the report, ensuring that the Exception content is processed to generate a valid output esp. for HTML pages.

The exception will be stored and the output will later be processed in a special way.

指定者:

println 在接口中 I_CmsReport

覆盖:

println 在类中 CmsHtmlReport

参数:

t - the exception to add

另请参阅:

I_CmsReport.println(java.lang.Throwable)

start

public void start()

Starts the report.

getLineBreak

protected java.lang.String getLineBreak()

从类复制的说明: CmsHtmlReport

Returns the correct line break notation depending on the output style of this report.

覆盖:

getLineBreak 在类中 CmsHtmlReport

返回:

the correct line break notation

另请参阅:

CmsHtmlReport.getLineBreak()