Package org.opencms.report

Class CmsShellLogReport

java.lang.Object

org.opencms.report.A_CmsReport

org.opencms.report.CmsHtmlReport

org.opencms.report.CmsPrintStreamReport

org.opencms.report.CmsShellReport

org.opencms.report.CmsShellLogReport

All Implemented Interfaces:

I_CmsReport

public class CmsShellLogReport
extends CmsShellReport

Report for shell which writes to LOG.

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

Constructors

Constructor	Description
CmsShellLogReport(Locale locale)	public constructor.

Method Summary

Modifier and Type	Method	Description
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	printMessageWithParam(int m, int n, CmsMessageContainer container, Object param)	Convenience method to print a localized message, followed by a parameter and dots to the report.
void	printMessageWithParam(CmsMessageContainer container, Object param)	Prints a localized message followed by a parametera and dots to the report.

Methods inherited from class org.opencms.report.CmsShellReport

addError, getOutputStream, getReportUpdate, println, start

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

addWarning, formatRuntime, getErrors, getLastEntryTime, getLocale, getMessages, getReportUpdate, 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 Details

CmsShellLogReport

public CmsShellLogReport(Locale locale)

public constructor.

Parameters:

locale - locale

Method Details

print

public void print(CmsMessageContainer container)

Description copied from interface: I_CmsReport

Prints a localized message to the report.

Specified by:

print in interface I_CmsReport

Overrides:

print in class CmsShellReport

Parameters:

container - the String to add

See Also:

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

print

public void print(CmsMessageContainer container,
 int format)

Description copied from interface: 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.

Specified by:

print in interface I_CmsReport

Overrides:

print in class CmsShellReport

Parameters:

container - the String to add

format - the formatting to use for the output

See Also:

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

println

public void println()

Description copied from interface: I_CmsReport

Adds a line break to the report.

Specified by:

println in interface I_CmsReport

Overrides:

println in class CmsShellReport

See Also:

• CmsPrintStreamReport.println()

println

public void println(CmsMessageContainer container)

Description copied from interface: I_CmsReport

Prints a localized message to the report.

Specified by:

println in interface I_CmsReport

Overrides:

println in class CmsShellReport

Parameters:

container - the message container to add

See Also:

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

println

public void println(CmsMessageContainer container,
 int format)

Description copied from interface: 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.

Specified by:

println in interface I_CmsReport

Overrides:

println in class CmsShellReport

Parameters:

container - the message container to add

format - the formatting to use for the output

See Also:

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

printMessageWithParam

public void printMessageWithParam(CmsMessageContainer container,
 Object param)

Description copied from interface: I_CmsReport

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

Specified by:

printMessageWithParam in interface I_CmsReport

Overrides:

printMessageWithParam in class CmsShellReport

Parameters:

container - the Message to add

param - the Parameter to add

See Also:

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

printMessageWithParam

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

Description copied from interface: 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 ...

Specified by:

printMessageWithParam in interface I_CmsReport

Overrides:

printMessageWithParam in class CmsShellReport

Parameters:

m - the number of the report output

n - the total number of report outputs

container - the Message to add

param - the Parameter to add

See Also:

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