AbstractPyroSink (adams-pom 24.5.0-SNAPSHOT API)

java.lang.Object
- adams.core.logging.LoggingObject
- - adams.core.logging.CustomLoggingLevelObject
  - - adams.core.option.AbstractOptionHandler
    - - adams.flow.core.AbstractPyroCall
      - adams.flow.sink.pyrosink.AbstractPyroSink

All Implemented Interfaces:

CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, FlowContextHandler, PyroCall, PyroInputConsumer, Serializable

Direct Known Subclasses:

Generic, Null
```
public abstract class AbstractPyroSink
extends AbstractPyroCall
implements PyroInputConsumer
```
Ancestor for Pyro calls that consume data but don't produce any output.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

protected Object m_Input
the input object.
- Fields inherited from class adams.flow.core.AbstractPyroCall
  m_FlowContext, m_MethodName, m_NameServer, m_RemoteObject, m_RemoteObjectName
- 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

AbstractPyroSink()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`cleanUp()`	Cleans up data structures, frees up memory.
`void`	`input(Object obj)`	The method that accepts the input object.
`protected String`	`postExecute()`	After performing the actual call.

Methods inherited from class adams.flow.core.AbstractPyroCall
defineOptions, doExecute, execute, getDefaultMethodName, getDefaultRemoteObjectName, getFlowContext, getMethodName, getQuickInfo, getRemoteObjectName, methodNameTipText, preExecute, remoteObjectNameTipText, reset, setFlowContext, setMethodName, setRemoteObjectName, setUp

Methods inherited from class adams.core.option.AbstractOptionHandler
cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, initialize, loggingLevelTipText, newOptionManager, 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.Destroyable
destroy

Methods inherited from interface adams.flow.core.FlowContextHandler
getFlowContext, setFlowContext

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

Methods inherited from interface adams.core.option.OptionHandler
cleanUpOptions, defineOptions, getOptionManager, toCommandLine

Methods inherited from interface adams.flow.core.PyroCall
execute, getMethodName, getRemoteObjectName, methodNameTipText, remoteObjectNameTipText, setMethodName, setRemoteObjectName, setUp

Methods inherited from interface adams.flow.core.PyroInputConsumer
accepts

- Field Detail
  - m_Input
```
protected Object m_Input
```
    the input object.
- Constructor Detail
  - AbstractPyroSink
```
public AbstractPyroSink()
```
- Method Detail
  - input
```
public void input(Object obj)
```
    The method that accepts the input object.
    
    Specified by:
    
    input in interface PyroInputConsumer
    
    Parameters:
    
    obj - the object to accept and process
  - postExecute
```
protected String postExecute()
```
    After performing the actual call.
    
    Overrides:
    
    postExecute in class AbstractPyroCall
    
    Returns:
    
    null if successful, otherwise error message
  - cleanUp
```
public void cleanUp()
```
    Cleans up data structures, frees up memory.
    
    Specified by:
    
    cleanUp in interface CleanUpHandler
    
    Overrides:
    
    cleanUp in class AbstractPyroCall