Package org.opennms.systemreport

Interface SystemReportFormatter

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void begin()
      Indicates that report output will begin.
      boolean canStdout()
      Whether this formatter should be allowed to write to STDOUT.
      void end()
      Indicates that report output will end.
      java.lang.String getContentType()
      The Content-Type that this formatter outputs.
      java.lang.String getDescription()
      A short description of the format.
      java.lang.String getExtension()
      The default extension to use when creating files if no output is specified.
      java.lang.String getName()
      A short name for this format for use by UIs when presenting an option of which formatter to choose.
      boolean needsOutputStream()
      Whether or not this formatter needs to be given an output stream.
      void setOutput​(java.lang.String output)
      The output string as passed on the command-line.
      void setOutputStream​(java.io.OutputStream stream)
      The output stream to use when writing data.
      void write​(SystemReportPlugin plugin)
      Write the data from the specified SystemReportPlugin.

      • Methods inherited from interface java.lang.Comparable

        compareTo

    • Method Detail

      • getName

        java.lang.String getName()
        A short name for this format for use by UIs when presenting an option of which formatter to choose.
        Returns:
        the format name (eg, "text", "xml", etc.)

      • getDescription

        java.lang.String getDescription()
        A short description of the format.
        Returns:
        the description

      • getContentType

        java.lang.String getContentType()
        The Content-Type that this formatter outputs. This can be null if the formatter does not produce a file (like the FtpSystemReportFormatter).
        Returns:
        the content-type the formatter writes.

      • getExtension

        java.lang.String getExtension()
        The default extension to use when creating files if no output is specified.
        Returns:
        the extension

      • needsOutputStream

        boolean needsOutputStream()
        Whether or not this formatter needs to be given an output stream.

      • setOutput

        void setOutput​(java.lang.String output)
        The output string as passed on the command-line.

      • setOutputStream

        void setOutputStream​(java.io.OutputStream stream)
        The output stream to use when writing data.
        Parameters:
        stream -

      • write

        void write​(SystemReportPlugin plugin)
        Write the data from the specified SystemReportPlugin.
        Parameters:
        plugin - the system report plugin which contains the data to write

      • begin

        void begin()
        Indicates that report output will begin.

      • end

        void end()
        Indicates that report output will end.

      • canStdout

        boolean canStdout()
        Whether this formatter should be allowed to write to STDOUT.