SimpleLogPanelResponseHandler (adams-pom 24.4.0-SNAPSHOT API)

java.lang.Object
- adams.core.logging.LoggingObject
- - adams.core.logging.CustomLoggingLevelObject
  - - adams.core.option.AbstractOptionHandler
    - - adams.scripting.responsehandler.AbstractResponseHandler
      - adams.scripting.responsehandler.SimpleLogPanelResponseHandler

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, ResponseHandler, Serializable
```
public class SimpleLogPanelResponseHandler
extends AbstractResponseHandler
```
For logging responses.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

protected SimpleLogPanel m_Log
the log to use.
- Fields inherited from class adams.scripting.responsehandler.AbstractResponseHandler
  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

Constructor Summary

Constructors
Constructor Description

SimpleLogPanelResponseHandler()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`displayErrorMessage(RemoteCommandWithErrorMessage cmd)`	Displays the error message.
`SimpleLogPanel`	`getLog()`	Returns the log in use.
`String`	`globalInfo()`	Returns a string describing the object.
`void`	`responseFailed(RemoteCommand cmd, String msg)`	Handles failed responses.
`void`	`responseSuccessful(RemoteCommand cmd)`	Handles successful responses.
`void`	`setLog(SimpleLogPanel value)`	Sets the log to use.

Methods inherited from class adams.scripting.responsehandler.AbstractResponseHandler
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 class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

- Field Detail
  - m_Log
```
protected SimpleLogPanel m_Log
```
    the log to use.
- Constructor Detail
  - SimpleLogPanelResponseHandler
```
public SimpleLogPanelResponseHandler()
```
- Method Detail
  - globalInfo
```
public String globalInfo()
```
    Returns a string describing the object.
    
    Specified by:
    
    globalInfo in interface GlobalInfoSupporter
    
    Specified by:
    
    globalInfo in class AbstractOptionHandler
    
    Returns:
    
    a description suitable for displaying in the gui
  - setLog
```
public void setLog(SimpleLogPanel value)
```
    Sets the log to use.
    
    Parameters:
    
    value - the log
  - getLog
```
public SimpleLogPanel getLog()
```
    Returns the log in use.
    
    Returns:
    
    the log
  - displayErrorMessage
```
protected void displayErrorMessage(RemoteCommandWithErrorMessage cmd)
```
    Displays the error message.
    
    Parameters:
    
    cmd - the command
  - responseSuccessful
```
public void responseSuccessful(RemoteCommand cmd)
```
    Handles successful responses.
    
    Parameters:
    
    cmd - the command with the response
  - responseFailed
```
public void responseFailed(RemoteCommand cmd,
                           String msg)
```
    Handles failed responses.
    
    Parameters:
    
    cmd - the command with the response
    
    msg - message, can be null