org.opencms.report
Class CmsStringBufferReport

java.lang.Object
  org.opencms.report.A_CmsReport
      org.opencms.report.CmsStringBufferReport

All Implemented Interfaces:

I_CmsReport

public class CmsStringBufferReport

extends A_CmsReport

Report class used to write the output of a report to a StringBuffer.

It stores everything and generates no output. After the report is finished, you can access to result of the report using the toString() method.

Since:

6.0.0

Version:

$Revision: 1.12 $

Author:

Thomas Weckert, Jan Baudisch

Field Summary

Fields inherited from interface org.opencms.report.I_CmsReport

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

Constructor Summary

CmsStringBufferReport(Locale locale)
Creates a new string buffer report.

CmsStringBufferReport(String bundleName, Locale locale)
Constructs a new string buffer report using the specified locale and resource bundle for the output language.

Method Summary

String	getReportUpdate() Updates this report, this processes all new output added since the last call to this method.
void	print(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(Throwable t) Adds an Exception to the report, ensuring that the Exception content is processed to generate a valid output esp.
String	toString()

Methods inherited from class org.opencms.report.A_CmsReport

addBundle, addError, formatRuntime, getErrors, getLocale, getRuntime, hasError, init, key, print, print, print, println, println, println, println, printMessageWithParam, printMessageWithParam, resetRuntime

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsStringBufferReport

public CmsStringBufferReport(Locale locale)

Creates a new string buffer report.

Parameters:

locale - the locale to use for the report output messages

CmsStringBufferReport

public CmsStringBufferReport(String bundleName,
                             Locale locale)

Constructs a new string buffer report using the specified locale and resource bundle for the output language.

Parameters:

locale - the locale to use for the report output messages

bundleName - the name of the resource bundle with localized strings

Method Detail

getReportUpdate

public String getReportUpdate()

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

Returns:

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

See Also:

I_CmsReport.getReportUpdate()

print

public void print(String value,
                  int format)

Description copied from class: A_CmsReport

Prints a String 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 class A_CmsReport

Parameters:

value - the message container to add

format - the formatting to use for the output

See Also:

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

println

public void println()

Description copied from interface: I_CmsReport

Adds a line break to the report.

See Also:

I_CmsReport.println()

println

public void println(Throwable t)

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

Parameters:

t - the exception to add

See Also:

I_CmsReport.println(java.lang.Throwable)

toString

public String toString()

See Also:

Object.toString()