Class PurgeQueue
- java.lang.Object
-
- adams.core.logging.LoggingObject
-
- adams.core.logging.CustomLoggingLevelObject
-
- adams.core.option.AbstractOptionHandler
-
- adams.core.net.rabbitmq.channelaction.AbstractChannelAction
-
- adams.core.net.rabbitmq.channelaction.PurgeQueue
-
- All Implemented Interfaces:
adams.core.Destroyable
,adams.core.GlobalInfoSupporter
,adams.core.logging.LoggingLevelHandler
,adams.core.logging.LoggingSupporter
,adams.core.option.OptionHandler
,adams.core.QuickInfoSupporter
,adams.core.SizeOfHandler
,Serializable
public class PurgeQueue extends AbstractChannelAction
Purges a queue.- Author:
- FracPete (fracpete at waikato dot ac dot nz)
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description PurgeQueue()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
defineOptions()
Adds options to the internal list of options.protected String
doPerformAction(com.rabbitmq.client.Channel channel)
Performs the action.String
getQueue()
Returns the name of the queue.String
getQuickInfo()
Returns a quick info about the actor, which will be displayed in the GUI.String
globalInfo()
Returns a string describing the object.String
queueTipText()
Returns the tip text for this property.void
setQueue(String value)
Sets the name of the queue.-
Methods inherited from class adams.core.net.rabbitmq.channelaction.AbstractChannelAction
check, performAction
-
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
-
-
-
-
Field Detail
-
m_Queue
protected String m_Queue
the name of the queue.
-
-
Method Detail
-
globalInfo
public String globalInfo()
Returns a string describing the object.- Specified by:
globalInfo
in interfaceadams.core.GlobalInfoSupporter
- Specified by:
globalInfo
in classadams.core.option.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 interfaceadams.core.option.OptionHandler
- Overrides:
defineOptions
in classadams.core.option.AbstractOptionHandler
-
getQuickInfo
public String getQuickInfo()
Returns a quick info about the actor, which will be displayed in the GUI.- Specified by:
getQuickInfo
in interfaceadams.core.QuickInfoSupporter
- Overrides:
getQuickInfo
in classAbstractChannelAction
- Returns:
- null if no info available, otherwise short string
-
setQueue
public void setQueue(String value)
Sets the name of the queue.- Parameters:
value
- the name
-
getQueue
public String getQueue()
Returns the name of the queue.- Returns:
- the name
-
queueTipText
public String queueTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
doPerformAction
protected String doPerformAction(com.rabbitmq.client.Channel channel)
Performs the action.- Specified by:
doPerformAction
in classAbstractChannelAction
- Parameters:
channel
- the channel to operate on- Returns:
- null if successful, otherwise error message
-
-