Package adams.core.net.rabbitmq.channelaction

Class DeleteExchange

  • 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 DeleteExchange
extends AbstractChannelActionWithWait
    Deletes a exchange.
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected String m_Exchange
      the name of the exchange.
      protected boolean m_IfUnused
      whether the exchange gets only deleted if not used.

      • 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
      DeleteExchange()  

    • Field Detail

      • m_Exchange

        protected String m_Exchange
        the name of the exchange.

      • m_IfUnused

        protected boolean m_IfUnused
        whether the exchange gets only deleted if not used.

    • Constructor Detail

      • DeleteExchange

        public DeleteExchange()

    • Method Detail

      • globalInfo

        public String globalInfo()
        Returns a string describing the object.
        Specified by:
        globalInfo in interface adams.core.GlobalInfoSupporter
        Specified by:
        globalInfo in class adams.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 interface adams.core.option.OptionHandler
        Overrides:
        defineOptions in class AbstractChannelActionWithWait

      • getQuickInfo

        public String getQuickInfo()
        Returns a quick info about the actor, which will be displayed in the GUI.
        Specified by:
        getQuickInfo in interface adams.core.QuickInfoSupporter
        Overrides:
        getQuickInfo in class AbstractChannelAction
        Returns:
        null if no info available, otherwise short string

      • setExchange

        public void setExchange​(String value)
        Sets the name of the exchange.
        Parameters:
        value - the name

      • getExchange

        public String getExchange()
        Returns the name of the exchange.
        Returns:
        the name

      • exchangeTipText

        public String exchangeTipText()
        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 exchange only if not used.
        Parameters:
        value - true if only if empty

      • getIfUnused

        public boolean getIfUnused()
        Returns whether to delete the exchange only if not used.
        Returns:
        true if only if empty

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

      • doPerformAction

        protected String doPerformAction​(com.rabbitmq.client.Channel channel)
        Performs the action.
        Specified by:
        doPerformAction in class AbstractChannelAction
        Parameters:
        channel - the channel to operate on
        Returns:
        null if successful, otherwise error message