Package adams.flow.websocket.client

Class SimpleSendWithQueueGenerator

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.websocket.client.AbstractWebSocketClientGenerator

adams.flow.websocket.client.SimpleSendWithQueueGenerator

All Implemented Interfaces:

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

public class SimpleSendWithQueueGenerator
extends AbstractWebSocketClientGenerator

Generates the SimpleSendWithQueue client.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected StorageName	m_StorageName	the name of the queue in the internal storage.

Fields inherited from class adams.flow.websocket.client.AbstractWebSocketClientGenerator

m_URL

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected com.pusher.java_websocket.client.WebSocketClient	doGenerate()	Generates the client.
String	getQuickInfo()	Returns a quick info about the actor, which will be displayed in the GUI.
StorageName	getStorageName()	Returns the name for the queue in the internal storage.
String	globalInfo()	Returns a string describing the object.
void	setStorageName(StorageName value)	Sets the name for the queue in the internal storage.
String	storageNameTipText()	Returns the tip text for this property.

Methods inherited from class adams.flow.websocket.client.AbstractWebSocketClientGenerator

check, generateClient, getURL, setURL, URLTipText

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.Destroyable

destroy

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager, toCommandLine

Field Detail

m_StorageName

protected StorageName m_StorageName

the name of the queue in the internal storage.

Constructor Detail

SimpleSendWithQueueGenerator

public SimpleSendWithQueueGenerator()

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 AbstractWebSocketClientGenerator

getQuickInfo

public String getQuickInfo()

Returns a quick info about the actor, which will be displayed in the GUI.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractWebSocketClientGenerator

Returns:

null if no info available, otherwise short string

setStorageName

public void setStorageName(StorageName value)

Sets the name for the queue in the internal storage.

Parameters:

value - the name

getStorageName

public StorageName getStorageName()

Returns the name for the queue in the internal storage.

Returns:

the name

storageNameTipText

public String storageNameTipText()

Returns the tip text for this property.

Returns:

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

doGenerate

protected com.pusher.java_websocket.client.WebSocketClient doGenerate()

Generates the client.

Specified by:

doGenerate in class AbstractWebSocketClientGenerator

Returns:

the client