Class DeleteQueue
- 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.AbstractChannelActionWithWait
-
- adams.core.net.rabbitmq.channelaction.DeleteQueue
-
- 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 DeleteQueue extends AbstractChannelActionWithWait
Deletes a queue.- Author:
- FracPete (fracpete at waikato dot ac dot nz)
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected boolean
m_IfEmpty
whether the queue gets only deleted if empty.protected boolean
m_IfUnused
whether the queue gets only deleted if not used.protected String
m_Queue
the name of the queue.-
Fields inherited from class adams.core.net.rabbitmq.channelaction.AbstractChannelActionWithWait
m_Wait
-
-
Constructor Summary
Constructors Constructor Description DeleteQueue()
-
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.boolean
getIfEmpty()
Returns whether to delete the queue only if empty.boolean
getIfUnused()
Returns whether to delete the queue only if not used.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
ifEmptyTipText()
Returns the tip text for this property.String
ifUnusedTipText()
Returns the tip text for this property.String
queueTipText()
Returns the tip text for this property.void
setIfEmpty(boolean value)
Sets whether to delete the queue only if empty.void
setIfUnused(boolean value)
Sets whether to delete the queue only if not used.void
setQueue(String value)
Sets the name of the queue.-
Methods inherited from class adams.core.net.rabbitmq.channelaction.AbstractChannelActionWithWait
getWait, setWait, waitTipText
-
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.
-
m_IfUnused
protected boolean m_IfUnused
whether the queue gets only deleted if not used.
-
m_IfEmpty
protected boolean m_IfEmpty
whether the queue gets only deleted if empty.
-
-
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 classAbstractChannelActionWithWait
-
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.
-
setIfUnused
public void setIfUnused(boolean value)
Sets whether to delete the queue only if not used.- Parameters:
value
- true if durable
-
getIfUnused
public boolean getIfUnused()
Returns whether to delete the queue only if not used.- Returns:
- true if durable
-
ifUnusedTipText
public String ifUnusedTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
setIfEmpty
public void setIfEmpty(boolean value)
Sets whether to delete the queue only if empty.- Parameters:
value
- true if only if empty
-
getIfEmpty
public boolean getIfEmpty()
Returns whether to delete the queue only if empty.- Returns:
- true if only if empty
-
ifEmptyTipText
public String ifEmptyTipText()
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
-
-