|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opencms.report.A_CmsReport
org.opencms.report.CmsHtmlReport
org.opencms.report.CmsPrintStreamReport
org.opencms.report.CmsShellReport
public class CmsShellReport
Report class used for the shell.
It stores nothing. It just prints everything to System.out
.
Field Summary |
---|
Fields inherited from class org.opencms.report.CmsHtmlReport |
---|
LINEBREAK, LINEBREAK_TRADITIONAL |
Fields inherited from interface org.opencms.report.I_CmsReport |
---|
FORMAT_DEFAULT, FORMAT_ERROR, FORMAT_HEADLINE, FORMAT_NOTE, FORMAT_OK, FORMAT_WARNING, REPORT_TYPE_EXTENDED, REPORT_TYPE_SIMPLE |
Constructor Summary | |
---|---|
CmsShellReport(java.util.Locale locale)
Constructs a new report using the provided locale for the output language. |
Method Summary | |
---|---|
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. |
Methods inherited from class org.opencms.report.CmsPrintStreamReport |
---|
close, finish, getLineBreak, print |
Methods inherited from class org.opencms.report.CmsHtmlReport |
---|
isWriteHtml |
Methods inherited from class org.opencms.report.A_CmsReport |
---|
addError, addWarning, formatRuntime, getErrors, getLastEntryTime, getLocale, getMessages, getRuntime, getSiteRoot, getWarnings, hasError, hasWarning, init, print, println, println, removeSiteRoot, resetRuntime, setLastEntryTime |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public CmsShellReport(java.util.Locale locale)
locale
- the locale to use for the output languageMethod Detail |
---|
public java.lang.String getReportUpdate()
I_CmsReport
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
in interface I_CmsReport
getReportUpdate
in class CmsPrintStreamReport
I_CmsReport.getReportUpdate()
public void print(CmsMessageContainer container)
I_CmsReport
print
in interface I_CmsReport
print
in class A_CmsReport
container
- the String to addA_CmsReport.print(org.opencms.i18n.CmsMessageContainer)
public void print(CmsMessageContainer container, int format)
I_CmsReport
Use the contants starting with FORMAT
from this interface
to indicate which formatting to use.
print
in interface I_CmsReport
print
in class A_CmsReport
container
- the String to addformat
- the formatting to use for the outputA_CmsReport.print(org.opencms.i18n.CmsMessageContainer, int)
public void println()
I_CmsReport
println
in interface I_CmsReport
println
in class CmsPrintStreamReport
CmsPrintStreamReport.println()
public void println(CmsMessageContainer container)
I_CmsReport
println
in interface I_CmsReport
println
in class A_CmsReport
container
- the message container to addA_CmsReport.println(org.opencms.i18n.CmsMessageContainer)
public void println(CmsMessageContainer container, int format)
I_CmsReport
Use the contants starting with FORMAT
from this interface
to indicate which formatting to use.
println
in interface I_CmsReport
println
in class A_CmsReport
container
- the message container to addformat
- the formatting to use for the outputA_CmsReport.println(org.opencms.i18n.CmsMessageContainer, int)
public void println(java.lang.Throwable t)
I_CmsReport
The exception will be stored and the output will later be processed in a special way.
println
in interface I_CmsReport
println
in class CmsPrintStreamReport
t
- the exception to addCmsPrintStreamReport.println(java.lang.Throwable)
public void printMessageWithParam(CmsMessageContainer container, java.lang.Object param)
I_CmsReport
printMessageWithParam
in interface I_CmsReport
printMessageWithParam
in class A_CmsReport
container
- the Message to addparam
- the Parameter to addA_CmsReport.printMessageWithParam(org.opencms.i18n.CmsMessageContainer, java.lang.Object)
public void printMessageWithParam(int m, int n, CmsMessageContainer container, java.lang.Object param)
I_CmsReport
The output follows the pattern: ( 3 / 8 ) Deleting filename.txt ...
printMessageWithParam
in interface I_CmsReport
printMessageWithParam
in class A_CmsReport
m
- the number of the report outputn
- the total number of report outputscontainer
- the Message to addparam
- the Parameter to addA_CmsReport.printMessageWithParam(int, int, org.opencms.i18n.CmsMessageContainer, java.lang.Object)
public void start()
CmsPrintStreamReport
start
in class CmsPrintStreamReport
CmsPrintStreamReport.start()
|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |