Package adams.flow.webservice.interceptor.incoming

Class LogFileGenerator

  • All Implemented Interfaces:
    adams.core.CleanUpHandler, adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.OptionalHandler, adams.core.SizeOfHandler, Serializable
    public class LogFileGenerator
extends AbstractInInterceptorGenerator<LogFile>
    Generator for LogFile.
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected adams.core.io.PlaceholderFile m_LogFile
      the file to write to.

      • Fields inherited from class adams.core.option.AbstractOptionHandler

        m_OptionManager

      • Fields inherited from class adams.core.logging.LoggingObject

        m_Logger, m_LoggingIsEnabled, m_LoggingLevel

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void defineOptions()
      Adds options to the internal list of options.
      protected LogFile doGenerate()
      Generates the actual interceptor for incoming messages.
      adams.core.io.PlaceholderFile getLogFile()
      Returns the log file to write to.
      String globalInfo()
      Returns a string describing the object.
      String logFileTipText()
      Returns the tip text for this property.
      void setLogFile​(adams.core.io.PlaceholderFile value)
      Sets the log file to write to.

      • Methods inherited from class adams.core.option.AbstractOptionHandler

        cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, toCommandLine, toString

      • Methods inherited from class adams.core.logging.CustomLoggingLevelObject

        setLoggingLevel

      • Methods inherited from class adams.core.logging.LoggingObject

        configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

      • Methods inherited from interface adams.core.Destroyable

        destroy

      • Methods inherited from interface adams.core.logging.LoggingLevelHandler

        getLoggingLevel

      • Methods inherited from interface adams.core.option.OptionHandler

        cleanUpOptions, getOptionManager, toCommandLine

    • Field Detail

      • m_LogFile

        protected adams.core.io.PlaceholderFile m_LogFile
        the file to write to.

    • Constructor Detail

      • LogFileGenerator

        public LogFileGenerator()

    • Method Detail

      • globalInfo

        public String globalInfo()
        Returns a string describing the object.
        Specified by:
        globalInfo in interface adams.core.GlobalInfoSupporter
        Specified by:
        globalInfo in class adams.core.option.AbstractOptionHandler
        Returns:
        a description suitable for displaying in the gui

      • setLogFile

        public void setLogFile​(adams.core.io.PlaceholderFile value)
        Sets the log file to write to.
        Parameters:
        value - the file to write to

      • getLogFile

        public adams.core.io.PlaceholderFile getLogFile()
        Returns the log file to write to.
        Returns:
        the file to write to

      • logFileTipText

        public String logFileTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.