Class CmsStringBufferReport

  • All Implemented Interfaces:

    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.

    • Constructor Detail

      • CmsStringBufferReport

        public CmsStringBufferReport​(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
    • Method Detail

      • getReportUpdate

        public java.lang.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.

        new elements that have been added to the report and not yet processed.
        See Also:
      • print

        public void print​(java.lang.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
        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​(java.lang.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.

        t - the exception to add
        See Also:
      • toString

        public java.lang.String toString()
        toString in class java.lang.Object
        See Also: