Class CmsPrintStreamReport

    • Constructor Detail

      • CmsPrintStreamReport

        public CmsPrintStreamReport​( printStream,
                                    java.util.Locale locale,
                                    boolean writeHtml)
        Constructs a new report using the provided locale for the output language.

        printStream - the print stream to write the output to
        locale - the locale to use for the output language
        writeHtml - decides if the report should write clear text or html code
    • Method Detail

      • close

        public void close()
        Closes the print stream.

        Has to be called after the report has finished.

      • finish

        public void finish()
        Finishes the report, closing the stream.

      • 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.

        Specified by:
        getReportUpdate in interface I_CmsReport
        getReportUpdate in class CmsHtmlReport
        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.

        print in class CmsHtmlReport
        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.

        Specified by:
        println in interface I_CmsReport
        println in class CmsHtmlReport
        t - the exception to add
        See Also:
      • start

        public void start()
        Starts the report.