Package adams.flow.sink.sendnotification

Class MultiNotification

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.sink.sendnotification.AbstractNotification

adams.flow.sink.sendnotification.MultiNotification

All Implemented Interfaces:

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

public class MultiNotification
extends AbstractNotification

Executes the notifications sequentially.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected AbstractNotification[]	m_Notifications	the notifications to combine.

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

Method Summary

Modifier and Type	Method	Description
protected String	check(String msg)	Hook method before attempting to send the message.
void	defineOptions()	Adds options to the internal list of options.
protected String	doSendNotification(String msg)	Sends the notification.
AbstractNotification[]	getNotifications()	Returns the notifications in use.
String	globalInfo()	Returns a string describing the object.
String	notificationsTipText()	Returns the tip text for this property.
void	setNotifications(AbstractNotification[] value)	Sets the notifications to use.

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

getFlowContext, getQuickInfo, 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_Notifications

protected AbstractNotification[] m_Notifications

the notifications to combine.

Constructor Detail

MultiNotification

public MultiNotification()

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

setNotifications

public void setNotifications(AbstractNotification[] value)

Sets the notifications to use.

Parameters:

value - the notifications

getNotifications

public AbstractNotification[] getNotifications()

Returns the notifications in use.

Returns:

the notifications

notificationsTipText

public String notificationsTipText()

Returns the tip text for this property.

Returns:

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

check

protected String check(String msg)

Hook method before attempting to send the message.

Overrides:

check in class AbstractNotification

Parameters:

msg - the message to send

Returns:

null if successful, otherwise error message

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