Package adams.docker.simpledocker

Class StopContainers

  • All Implemented Interfaces:
    adams.core.CleanUpHandler, adams.core.command.AsyncCapableExternalCommand, adams.core.command.ExternalCommand, adams.core.command.ExternalCommandWithOptions, adams.core.command.ExternalCommandWithProgrammaticArguments, adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.QuickInfoSupporter, adams.core.SizeOfHandler, adams.core.Stoppable, adams.core.StoppableWithFeedback, DockerCommand, DockerCommandWithProgrammaticArguments, adams.flow.core.FlowContextHandler, Serializable
    public class StopContainers
extends AbstractDockerCommandWithOptions
implements DockerCommandWithProgrammaticArguments
    For stopping containers.
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected String[] m_AdditionalArguments
      the additional arguments.
      protected int m_Wait
      for number of seconds to wait.

      • Fields inherited from class adams.core.command.AbstractAsyncCapableExternalCommandWithOptions

        m_Options, m_OptionsString

      • Fields inherited from class adams.core.command.AbstractAsyncCapableExternalCommand

        m_Blocking, m_ProcessOutput

      • Fields inherited from class adams.core.command.AbstractExternalCommand

        m_Executed, m_FlowContext, m_LastCommand, m_Output, m_OutputFormatter, m_OutputType, m_Running, m_StdErrProcessor, m_StdOutProcessor, m_Stopped

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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected List<String> buildCommand()
      Assembles the command to run.
      void defineOptions()
      Adds options to the internal list of options.
      String[] getAdditionalArguments()
      Returns the additional arguments to append to the command.
      String getQuickInfo()
      Returns a quick info about the actor, which will be displayed in the GUI.
      int getWait()
      Returns the number of seconds to wait before stopping.
      String globalInfo()
      Returns a string describing the object.
      void setAdditionalArguments​(String[] value)
      Sets the additional arguments to append to the command.
      void setWait​(int value)
      Sets the number of seconds to wait before stopping.
      String waitTipText()
      Returns the tip text for this property.

      • Methods inherited from class adams.core.command.AbstractAsyncCapableExternalCommandWithOptions

        getActualOptions, getOptions, getOptionsString, optionsStringTipText, optionsTipText, setOptions, setOptions, setOptions, setOptionsString, setOptionsString

      • Methods inherited from class adams.core.command.AbstractAsyncCapableExternalCommand

        addStdErr, addStdOut, blockingTipText, doAsyncExecute, getBlocking, getDefaultBlocking, isFinished, isUsingBlocking, setBlocking, stopExecution

      • Methods inherited from class adams.core.command.AbstractExternalCommand

        addFormattedOutput, commandResultToError, execute, generates, getDefaultOutputFormatter, getDefaultOutputType, getDefaultStdErrProcessor, getDefaultStdOutProcessor, getFlowContext, getLastCommand, getOutputFormatter, getOutputType, getStdErrProcessor, getStdOutProcessor, hasLastCommand, hasOutput, initialize, isExecuted, isRunning, isStopped, log, log, log, output, outputFormatterTipText, outputTypeTipText, reset, setFlowContext, setOutputFormatter, setOutputType, setStdErrProcessor, setStdOutProcessor, stdErrProcessorTipText, stdOutProcessorTipText

      • Methods inherited from class adams.core.option.AbstractOptionHandler

        cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, loggingLevelTipText, newOptionManager, setLoggingLevel, toCommandLine, toString

      • Methods inherited from class adams.core.logging.LoggingObject

        configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

      • Methods inherited from interface adams.core.command.AsyncCapableExternalCommand

        addStdErr, addStdOut, blockingTipText, getBlocking, setBlocking

      • Methods inherited from interface adams.core.Destroyable

        destroy

      • Methods inherited from interface adams.core.command.ExternalCommand

        addFormattedOutput, cleanUp, execute, generates, getLastCommand, getOutputFormatter, getOutputType, getStdErrProcessor, getStdOutProcessor, hasLastCommand, hasOutput, isExecuted, isFinished, isRunning, isUsingBlocking, output, outputFormatterTipText, outputTypeTipText, setOutputFormatter, setOutputType, setStdErrProcessor, setStdOutProcessor, stdErrProcessorTipText, stdOutProcessorTipText

      • Methods inherited from interface adams.flow.core.FlowContextHandler

        getFlowContext, setFlowContext

      • Methods inherited from interface adams.core.logging.LoggingLevelHandler

        getLoggingLevel

      • Methods inherited from interface adams.core.option.OptionHandler

        cleanUpOptions, getOptionManager, toCommandLine

      • Methods inherited from interface adams.core.Stoppable

        stopExecution

      • Methods inherited from interface adams.core.StoppableWithFeedback

        isStopped

    • Field Detail

      • m_Wait

        protected int m_Wait
        for number of seconds to wait.

      • m_AdditionalArguments

        protected String[] m_AdditionalArguments
        the additional arguments.

    • Constructor Detail

      • StopContainers

        public StopContainers()

    • 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 adams.core.command.AbstractAsyncCapableExternalCommandWithOptions

      • 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 adams.core.command.AbstractAsyncCapableExternalCommandWithOptions
        Returns:
        null if no info available, otherwise short string

      • setWait

        public void setWait​(int value)
        Sets the number of seconds to wait before stopping.
        Parameters:
        value - the number of seconds

      • getWait

        public int getWait()
        Returns the number of seconds to wait before stopping.
        Returns:
        the number of seconds

      • waitTipText

        public String waitTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setAdditionalArguments

        public void setAdditionalArguments​(String[] value)
        Sets the additional arguments to append to the command.
        Specified by:
        setAdditionalArguments in interface adams.core.command.ExternalCommandWithProgrammaticArguments
        Parameters:
        value - the arguments

      • getAdditionalArguments

        public String[] getAdditionalArguments()
        Returns the additional arguments to append to the command.
        Specified by:
        getAdditionalArguments in interface adams.core.command.ExternalCommandWithProgrammaticArguments
        Returns:
        the arguments