org.opencms.report

类 CmsShellReport

java.lang.Object

org.opencms.report.A_CmsReport

org.opencms.report.CmsHtmlReport

org.opencms.report.CmsPrintStreamReport

org.opencms.report.CmsShellReport

所有已实现的接口:

I_CmsReport

public class CmsShellReport
extends CmsPrintStreamReport

Report class used for the shell.

It stores nothing. It just prints everything to System.out

.

从以下版本开始:

6.0.0

字段概要

从类继承的字段 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

构造器概要

构造器

构造器和说明
CmsShellReport(java.util.Locale locale) Constructs a new report using the provided locale for the output language.

方法概要

方法

限定符和类型	方法和说明
java.lang.String	getReportUpdate() Updates this report, this processes all new output added since the last call to this method.
void	print(CmsMessageContainer container) Prints a localized message to the report.
void	print(CmsMessageContainer container, int format) Prints a localized message to the report, using the indicated formatting.
void	println() Adds a line break to the report.
void	println(CmsMessageContainer container) Prints a localized message to the report.
void	println(CmsMessageContainer container, int format) Prints a localized message to the report, using the indicated formatting.
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	printMessageWithParam(CmsMessageContainer container, java.lang.Object param) Prints a localized message followed by a parametera and dots to the report.
void	printMessageWithParam(int m, int n, CmsMessageContainer container, java.lang.Object param) Convenience method to print a localized message, followed by a parameter and dots to the report.
void	start() Starts the report.

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

close, finish, getLineBreak, print

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

isWriteHtml

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

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

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

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

构造器详细资料

CmsShellReport

public CmsShellReport(java.util.Locale locale)

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

参数:

locale - the locale to use for the output language

方法详细资料

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 在类中 CmsPrintStreamReport

返回:

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

另请参阅:

I_CmsReport.getReportUpdate()

print

public void print(CmsMessageContainer container)

从接口复制的说明: I_CmsReport

Prints a localized message to the report.

指定者:

print 在接口中 I_CmsReport

覆盖:

print 在类中 A_CmsReport

参数:

container - the String to add

另请参阅:

A_CmsReport.print(org.opencms.i18n.CmsMessageContainer)

print

public void print(CmsMessageContainer container,
         int format)

从接口复制的说明: I_CmsReport

Prints a localized message to the report, using the indicated formatting.

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

指定者:

print 在接口中 I_CmsReport

覆盖:

print 在类中 A_CmsReport

参数:

container - the String to add

format - the formatting to use for the output

另请参阅:

A_CmsReport.print(org.opencms.i18n.CmsMessageContainer, int)

println

public void println()

从接口复制的说明: I_CmsReport

Adds a line break to the report.

指定者:

println 在接口中 I_CmsReport

覆盖:

println 在类中 CmsPrintStreamReport

另请参阅:

CmsPrintStreamReport.println()

println

public void println(CmsMessageContainer container)

从接口复制的说明: I_CmsReport

Prints a localized message to the report.

指定者:

println 在接口中 I_CmsReport

覆盖:

println 在类中 A_CmsReport

参数:

container - the message container to add

另请参阅:

A_CmsReport.println(org.opencms.i18n.CmsMessageContainer)

println

public void println(CmsMessageContainer container,
           int format)

从接口复制的说明: I_CmsReport

Prints a localized message to the report, using the indicated formatting.

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

指定者:

println 在接口中 I_CmsReport

覆盖:

println 在类中 A_CmsReport

参数:

container - the message container to add

format - the formatting to use for the output

另请参阅:

A_CmsReport.println(org.opencms.i18n.CmsMessageContainer, int)

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 在类中 CmsPrintStreamReport

参数:

t - the exception to add

另请参阅:

CmsPrintStreamReport.println(java.lang.Throwable)

printMessageWithParam

public void printMessageWithParam(CmsMessageContainer container,
                         java.lang.Object param)

从接口复制的说明: I_CmsReport

Prints a localized message followed by a parametera and dots to the report.

指定者:

printMessageWithParam 在接口中 I_CmsReport

覆盖:

printMessageWithParam 在类中 A_CmsReport

参数:

container - the Message to add

param - the Parameter to add

另请参阅:

A_CmsReport.printMessageWithParam(org.opencms.i18n.CmsMessageContainer, java.lang.Object)

printMessageWithParam

public void printMessageWithParam(int m,
                         int n,
                         CmsMessageContainer container,
                         java.lang.Object param)

从接口复制的说明: I_CmsReport

Convenience method to print a localized message, followed by a parameter and dots to the report.

The output follows the pattern: ( 3 / 8 ) Deleting filename.txt ...

指定者:

printMessageWithParam 在接口中 I_CmsReport

覆盖:

printMessageWithParam 在类中 A_CmsReport

参数:

m - the number of the report output

n - the total number of report outputs

container - the Message to add

param - the Parameter to add

另请参阅:

A_CmsReport.printMessageWithParam(int, int, org.opencms.i18n.CmsMessageContainer, java.lang.Object)

start

public void start()

从类复制的说明: CmsPrintStreamReport

Starts the report.

覆盖:

start 在类中 CmsPrintStreamReport

另请参阅:

CmsPrintStreamReport.start()