Package org.opencms.report.wrapper

Class CmsReportWrapper

  • public class CmsReportWrapper
extends java.lang.Object
    Wrapper for writing reports. It allows to write the same messages to multiple reports and has high-level interface for writing.
    Since:
    12.0.0
    Version:
    $Revision: 1.0 $
    Author:
    Daniel Seidel

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void reportAddWarning​(java.lang.Object warning)
      Adds a warning to the report (invisible in the GUI).
      void reportDefault​(java.lang.String message, java.lang.Object... params)
      Print a message in default style.
      void reportDefaultNoBreak​(java.lang.String message, java.lang.Object... params)
      Print a message in default style without linebreak.
      void reportFailed​(boolean withDots)
      Report failed.
      void reportFailed​(java.lang.String message, java.lang.Object... params)
      Report failed.
      void reportHeadline​(java.lang.String message, java.lang.Object... params)
      Print a message as headline.
      void reportHeadlineNoBreak​(java.lang.String message, java.lang.Object... params)
      Print a message as headline.
      void reportNewline()
      Prints an empty line.
      void reportNote​(java.lang.String message, java.lang.Object... params)
      Print a message as note.
      void reportNoteNoBreak​(java.lang.String message, java.lang.Object... params)
      Print a message as note without linebreak.
      void reportOk​(boolean withDots)
      Report ok.
      void reportOk​(java.lang.String message, java.lang.Object... params)
      Report ok.
      void reportSkipped​(boolean withDots)
      Report ok.
      void reportSkipped​(java.lang.String message, java.lang.Object... params)
      Report skipped.
      void reportWarning​(java.lang.String message, java.lang.Object... params)
      Print a message in warning style.
      void reportWarningNoBreak​(java.lang.String message, java.lang.Object... params)
      Print a message in warning style.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • CmsReportWrapper

        public CmsReportWrapper​(I_CmsMessageBundle messages,
                        java.util.Collection<I_CmsReport> reports)
        Constructor for the wrapper.
        Parameters:
        messages - the message bundle to read the printed messages from.
        reports - the reports to write to.

      • CmsReportWrapper

        public CmsReportWrapper​(I_CmsMessageBundle messages,
                        I_CmsReport... report)
        Constructor for the wrapper.
        Parameters:
        messages - the message bundle to read the printed messages from.
        report - a sequence of reports to write the messages to.

    • Method Detail

      • reportAddWarning

        public void reportAddWarning​(java.lang.Object warning)
        Adds a warning to the report (invisible in the GUI).
        Parameters:
        warning - the warning to add.

      • reportDefault

        public void reportDefault​(java.lang.String message,
                          java.lang.Object... params)
        Print a message in default style.
        Parameters:
        message - the message
        params - the parameters

      • reportDefaultNoBreak

        public void reportDefaultNoBreak​(java.lang.String message,
                                 java.lang.Object... params)
        Print a message in default style without linebreak.
        Parameters:
        message - the message
        params - the parameters

      • reportFailed

        public void reportFailed​(boolean withDots)
        Report failed.
        Parameters:
        withDots - with dots or only the word.

      • reportFailed

        public void reportFailed​(java.lang.String message,
                         java.lang.Object... params)
        Report failed.
        Parameters:
        message - the message to print
        params - parameters of the message

      • reportHeadline

        public void reportHeadline​(java.lang.String message,
                           java.lang.Object... params)
        Print a message as headline.
        Parameters:
        message - the message
        params - the parameters

      • reportHeadlineNoBreak

        public void reportHeadlineNoBreak​(java.lang.String message,
                                  java.lang.Object... params)
        Print a message as headline.
        Parameters:
        message - the message
        params - the parameters

      • reportNewline

        public void reportNewline()
        Prints an empty line.

      • reportNote

        public void reportNote​(java.lang.String message,
                       java.lang.Object... params)
        Print a message as note.
        Parameters:
        message - the message
        params - the parameters

      • reportNoteNoBreak

        public void reportNoteNoBreak​(java.lang.String message,
                              java.lang.Object... params)
        Print a message as note without linebreak.
        Parameters:
        message - the message
        params - the parameters

      • reportOk

        public void reportOk​(boolean withDots)
        Report ok.
        Parameters:
        withDots - with dots or only the word.

      • reportOk

        public void reportOk​(java.lang.String message,
                     java.lang.Object... params)
        Report ok.
        Parameters:
        message - the message to print
        params - parameters of the message

      • reportSkipped

        public void reportSkipped​(boolean withDots)
        Report ok.
        Parameters:
        withDots - with dots or only the word.

      • reportSkipped

        public void reportSkipped​(java.lang.String message,
                          java.lang.Object... params)
        Report skipped.
        Parameters:
        message - the message to print
        params - parameters of the message

      • reportWarning

        public void reportWarning​(java.lang.String message,
                          java.lang.Object... params)
        Print a message in warning style.
        Parameters:
        message - the message
        params - the parameters

      • reportWarningNoBreak

        public void reportWarningNoBreak​(java.lang.String message,
                                 java.lang.Object... params)
        Print a message in warning style.
        Parameters:
        message - the message
        params - the parameters