Package org.opencms.report.wrapper

Class CmsReportWrapper

java.lang.Object
org.opencms.report.wrapper.CmsReportWrapper
public class CmsReportWrapper extends 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

  • Constructor Details

    • CmsReportWrapper

      public CmsReportWrapper(I_CmsMessageBundle messages, 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 Details

    • reportAddWarning

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

    • reportDefault

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

    • reportDefaultNoBreak

      public void reportDefaultNoBreak(String message, 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(String message, Object... params)
      Report failed.
      Parameters:
      message - the message to print
      params - parameters of the message

    • reportHeadline

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

    • reportHeadlineNoBreak

      public void reportHeadlineNoBreak(String message, 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(String message, Object... params)
      Print a message as note.
      Parameters:
      message - the message
      params - the parameters

    • reportNoteNoBreak

      public void reportNoteNoBreak(String message, 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(String message, 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(String message, Object... params)
      Report skipped.
      Parameters:
      message - the message to print
      params - parameters of the message

    • reportWarning

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

    • reportWarningNoBreak

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