Package adams.flow.sink.sendnotification

Class MessageBox

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.sink.sendnotification.AbstractNotification

adams.flow.sink.sendnotification.MessageBox

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, FlowContextHandler, Serializable

public class MessageBox
extends AbstractNotification

Simply pops up a message box with the notification. Outputs to stdout if in headless environment.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	m_Block	whether to block the flow execution.

Fields inherited from class adams.flow.sink.sendnotification.AbstractNotification

m_FlowContext

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
MessageBox()

Method Summary

Modifier and Type	Method	Description
String	blockTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
protected String	doSendNotification(String msg)	Sends the notification.
boolean	getBlock()	Returns whether to block flow execution.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
String	globalInfo()	Returns a string describing the object.
void	setBlock(boolean value)	Sets whether to block flow execution.

Methods inherited from class adams.flow.sink.sendnotification.AbstractNotification

check, getFlowContext, sendNotification, setFlowContext

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_Block

protected boolean m_Block

whether to block the flow execution.

Constructor Detail

MessageBox

public MessageBox()

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

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

setBlock

public void setBlock(boolean value)

Sets whether to block flow execution.

Parameters:

value - true if to block

getBlock

public boolean getBlock()

Returns whether to block flow execution.

Returns:

true if to block

blockTipText

public String blockTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

getQuickInfo

public String getQuickInfo()

Returns a quick info about the object, which can be displayed in the GUI.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractNotification

Returns:

null if no info available, otherwise short string

doSendNotification

protected String doSendNotification(String msg)

Sends the notification.

Specified by:

doSendNotification in class AbstractNotification

Parameters:

msg - the message to send

Returns:

null if successfully sent, otherwise error message