Package org.opencms.report

Class CmsMultiplexReport

java.lang.Object

org.opencms.report.A_CmsReport

org.opencms.report.CmsMultiplexReport

All Implemented Interfaces:

I_CmsReport

public class CmsMultiplexReport
extends A_CmsReport

Report proxy that multiplexes to all contained I_CmsReport instances.

Since:

7.5.1

Field Summary

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
CmsMultiplexReport()	Default constructor.

Method Summary

Modifier and Type	Method	Description
void	addReport(A_CmsReport report)	Adds the given report to become a proxy delegate of this multiplexer.
long	getLastEntryTime()	Returns the time of last report entry.
Locale	getLocale()	Returns the locale this report was initialized with.
String	getReportUpdate()	This searches for the first instance of a link in the internal delegate list and returns the value of it's invocation.
protected void	print(String value, int format)	Prints a String to the report, using the indicated formatting.
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(Throwable t)	Adds an Exception to the report, ensuring that the Exception content is processed to generate a valid output esp.
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.
void	resetRuntime()	Resets the runtime to 0 milliseconds.

Methods inherited from class org.opencms.report.A_CmsReport

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

Methods inherited from class java.lang.Object

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

Constructor Details

CmsMultiplexReport

public CmsMultiplexReport()

Default constructor.

Method Details

addReport

public void addReport(A_CmsReport report)

Adds the given report to become a proxy delegate of this multiplexer.

Parameters:

report - the report to be on the recipient list.

getLastEntryTime

public long getLastEntryTime()

Description copied from interface: I_CmsReport

Returns the time of last report entry.

Will return zero if no entry has been written.

Specified by:

getLastEntryTime in interface I_CmsReport

Overrides:

getLastEntryTime in class A_CmsReport

Returns:

time of last report entry

See Also:

• A_CmsReport.getLastEntryTime()

getLocale

public Locale getLocale()

Description copied from interface: I_CmsReport

Returns the locale this report was initialized with.

Specified by:

getLocale in interface I_CmsReport

Overrides:

getLocale in class A_CmsReport

Returns:

the locale this report was initialized with

See Also:

• A_CmsReport.getLocale()

getReportUpdate

public String getReportUpdate()

This searches for the first instance of a link in the internal delegate list and returns the value of it's invocation.

If no such report is found an empty String will be returned.

Returns:

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

See Also:

• I_CmsReport.getReportUpdate()

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 A_CmsReport

Parameters:

container - the String to add

See Also:

• I_CmsReport.print(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 A_CmsReport

Parameters:

container - the String to add

format - the formatting to use for the output

See Also:

• I_CmsReport.print(CmsMessageContainer, 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(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 A_CmsReport

Parameters:

container - the message container to add

See Also:

• I_CmsReport.println(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 A_CmsReport

Parameters:

container - the message container to add

format - the formatting to use for the output

See Also:

• I_CmsReport.println(CmsMessageContainer, int)

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(Throwable)

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 A_CmsReport

Parameters:

container - the Message to add

param - the Parameter to add

See Also:

• I_CmsReport.printMessageWithParam(CmsMessageContainer, 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 A_CmsReport

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:

• I_CmsReport.printMessageWithParam(int, int, CmsMessageContainer, Object)

resetRuntime

public void resetRuntime()

Description copied from interface: I_CmsReport

Resets the runtime to 0 milliseconds.

Specified by:

resetRuntime in interface I_CmsReport

Overrides:

resetRuntime in class A_CmsReport

See Also:

• I_CmsReport.resetRuntime()

print

protected void print(String value,
 int format)

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

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)