AbstractScript (adams-pom 24.5.0-SNAPSHOT API)

java.lang.Object
- adams.core.logging.LoggingObject
- - adams.core.logging.CustomLoggingLevelObject
  - - adams.core.option.AbstractOptionHandler
    - - adams.tools.AbstractTool
      - adams.tools.AbstractScript

All Implemented Interfaces:

CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, Stoppable, StoppableWithFeedback, AdditionalOptionsHandler, Serializable, Comparable
```
public abstract class AbstractScript
extends AbstractTool
implements AdditionalOptionsHandler
```
Ancestor for tool scripts.

Scripts of scripting languages like Jython or Groovy need to be derived from this class.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

protected AdditionalOptions m_AdditionalOptions
for storing the additional options.
- Fields inherited from class adams.tools.AbstractTool
  m_Stopped
- 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

AbstractScript()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`AdditionalOptions`	`getAdditionalOptions()`	Returns the value associated with the (additional) option.
`protected void`	`initialize()`	Initializes the members.
`void`	`setAdditionalOptions(AdditionalOptions options)`	Sets the additional options.

Methods inherited from class adams.tools.AbstractTool
cleanUp, compareTo, destroy, doRun, equals, forCommandLine, forName, getTools, isStopped, postRun, preRun, run, runTool, stopExecution

Methods inherited from class adams.core.option.AbstractOptionHandler
cleanUpOptions, defineOptions, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, 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, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

- Field Detail
  - m_AdditionalOptions
```
protected AdditionalOptions m_AdditionalOptions
```
    for storing the additional options.
- Constructor Detail
  - AbstractScript
```
public AbstractScript()
```
- Method Detail
  - initialize
```
protected void initialize()
```
    Initializes the members.
    
    Overrides:
    
    initialize in class AbstractOptionHandler
  - setAdditionalOptions
```
public void setAdditionalOptions(AdditionalOptions options)
```
    Sets the additional options.
    
    Specified by:
    
    setAdditionalOptions in interface AdditionalOptionsHandler
    
    Parameters:
    
    options - the options (name <->value relation)
  - getAdditionalOptions
```
public AdditionalOptions getAdditionalOptions()
```
    Returns the value associated with the (additional) option.
    
    Specified by:
    
    getAdditionalOptions in interface AdditionalOptionsHandler
    
    Returns:
    
    the options (name <->value relation)