Package adams.scripting.requesthandler

Class LogTextBoxRequestHandler

  • All Implemented Interfaces:
    adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.SizeOfHandler, adams.scripting.requesthandler.RequestHandler, Serializable
    public class LogTextBoxRequestHandler
extends adams.scripting.requesthandler.AbstractRequestHandler
    For logging requests.
    Version:
    $Revision$
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected LogTextBox m_Log
      the log to use.

      • Fields inherited from class adams.scripting.requesthandler.AbstractRequestHandler

        m_Enabled, m_Owner

      • 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
      LogTextBox getLog()
      Returns the log in use.
      String globalInfo()
      Returns a string describing the object.
      void requestFailed​(adams.scripting.command.RemoteCommand cmd, String msg)
      Handles failed requests.
      void requestRejected​(adams.scripting.command.RemoteCommand cmd, String msg)
      Handles rejected requests.
      void requestSuccessful​(adams.scripting.command.RemoteCommand cmd)
      Handles successfuly requests.
      void setLog​(LogTextBox value)
      Sets the log to use.

      • Methods inherited from class adams.scripting.requesthandler.AbstractRequestHandler

        defineOptions, enabledTipText, getEnabled, getOwner, insertHandler, setEnabled, setOwner

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

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

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

        configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

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

        getLoggingLevel

    • Field Detail

      • m_Log

        protected LogTextBox m_Log
        the log to use.

    • Constructor Detail

      • LogTextBoxRequestHandler

        public LogTextBoxRequestHandler()

    • 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

      • setLog

        public void setLog​(LogTextBox value)
        Sets the log to use.
        Parameters:
        value - the log

      • getLog

        public LogTextBox getLog()
        Returns the log in use.
        Returns:
        the log

      • requestSuccessful

        public void requestSuccessful​(adams.scripting.command.RemoteCommand cmd)
        Handles successfuly requests.
        Parameters:
        cmd - the command with the request

      • requestFailed

        public void requestFailed​(adams.scripting.command.RemoteCommand cmd,
                          String msg)
        Handles failed requests.
        Parameters:
        cmd - the command with the request
        msg - the optional error message, can be null

      • requestRejected

        public void requestRejected​(adams.scripting.command.RemoteCommand cmd,
                            String msg)
        Handles rejected requests.
        Parameters:
        cmd - the command with the request
        msg - the optional error message, can be null