AbstractConnectionEnhancer (adams-pom 24.4.0-SNAPSHOT API)

java.lang.Object
- adams.core.logging.LoggingObject
- - adams.core.logging.CustomLoggingLevelObject
  - - adams.core.option.AbstractOptionHandler
    - - adams.scripting.connection.AbstractConnection
      - adams.scripting.connection.AbstractConnectionEnhancer

All Implemented Interfaces:

CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, Connection, Serializable, Comparable<Connection>
```
public abstract class AbstractConnectionEnhancer
extends AbstractConnection
```
Ancestor connections that enhance a base connection.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

protected Connection m_Connection
the connection to use.
- 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

AbstractConnectionEnhancer()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`abstract String`	`connectionTipText()`	Returns the tip text for this property.
`void`	`defineOptions()`	Adds options to the internal list of options.
`Connection`	`getConnection()`	Returns the connection to use.
`protected Connection`	`getDefaultConnection()`	Returns the default connection to use.
`void`	`setConnections(Connection value)`	Sets the connection to use.

Methods inherited from class adams.scripting.connection.AbstractConnection
checkRequest, checkResponse, cleanUp, compareTo, doSendRequest, doSendResponse, equals, getQuickInfo, sendRequest, sendResponse, toString

Methods inherited from class adams.core.option.AbstractOptionHandler
cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine

Methods inherited from class adams.core.logging.LoggingObject
configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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_Connection
```
protected Connection m_Connection
```
    the connection to use.
- Constructor Detail
  - AbstractConnectionEnhancer
```
public AbstractConnectionEnhancer()
```
- Method Detail
  - defineOptions
```
public void defineOptions()
```
    Adds options to the internal list of options.
    
    Specified by:
    
    defineOptions in interface OptionHandler
    
    Overrides:
    
    defineOptions in class AbstractOptionHandler
  - getDefaultConnection
```
protected Connection getDefaultConnection()
```
    Returns the default connection to use.
    
    Returns:
    
    the default
  - setConnections
```
public void setConnections(Connection value)
```
    Sets the connection to use.
    
    Parameters:
    
    value - the connection
  - getConnection
```
public Connection getConnection()
```
    Returns the connection to use.
    
    Returns:
    
    the connection
  - connectionTipText
```
public abstract String connectionTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the gui