Package adams.flow.standalone.rats.input

Class DummyInput

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.standalone.rats.input.AbstractRatInput

adams.flow.standalone.rats.input.DummyInput

All Implemented Interfaces:

adams.core.AdditionalInformationHandler, adams.core.CleanUpHandler, adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.QuickInfoSupporter, adams.core.ShallowCopySupporter<AbstractRatInput>, adams.core.SizeOfHandler, adams.core.Stoppable, adams.core.StoppableWithFeedback, RatInput, Serializable

public class DummyInput
extends AbstractRatInput

Dummy input receiver, does nothing.

-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields inherited from class adams.flow.standalone.rats.input.AbstractRatInput

m_LoggingPrefix, m_Owner, m_ReceptionInterrupted, m_ReceptionRunning, 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
DummyInput()

Method Summary

Modifier and Type	Method	Description
protected String	doReceive()	Performs the actual reception of data.
Class	generates()	Returns the type of data this scheme generates.
String	globalInfo()	Returns a string describing the object.
boolean	hasPendingOutput()	Checks whether any output can be collected.
Object	output()	Returns the received data.

Methods inherited from class adams.flow.standalone.rats.input.AbstractRatInput

canReceive, check, cleanUp, configureLogger, doWait, getAdditionalInformation, getFullName, getOwner, getQueue, getQuickInfo, getReceptionInterrupted, handleException, initialize, initReception, interruptReception, isReceptionRunning, isStopped, receive, setOwner, setUp, shallowCopy, shallowCopy, stopExecution, updatePrefix

Methods inherited from class adams.core.option.AbstractOptionHandler

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

Methods inherited from class adams.core.logging.LoggingObject

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.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, defineOptions, getOptionManager, toCommandLine

Constructor Detail

DummyInput

public DummyInput()

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

generates

public Class generates()

Returns the type of data this scheme generates.

Specified by:

generates in interface RatInput

Specified by:

generates in class AbstractRatInput

Returns:

the class

hasPendingOutput

public boolean hasPendingOutput()

Checks whether any output can be collected.

Specified by:

hasPendingOutput in interface RatInput

Specified by:

hasPendingOutput in class AbstractRatInput

Returns:

true if output available

output

public Object output()

Returns the received data.

Specified by:

output in interface RatInput

Specified by:

output in class AbstractRatInput

Returns:

the data

doReceive

protected String doReceive()

Performs the actual reception of data.

Does nothing.

Specified by:

doReceive in class AbstractRatInput

Returns:

null if successful, otherwise error message