Package adams.docker.simpledocker

Class ListContainers

  • All Implemented Interfaces:
    adams.core.CleanUpHandler, adams.core.command.AsyncCapableExternalCommand, adams.core.command.ExternalCommand, adams.core.command.ExternalCommandWithOptions, 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, adams.flow.core.FlowContextHandler, Serializable
    public class ListContainers
extends AbstractDockerCommandWithOptions
    For listing container IDs.
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected boolean m_All
      whether to list all containers.
      protected String m_Filter
      for filtering the containers.
      protected boolean m_ShowOnlyIDs
      whether to only show the IDs.

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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      String allTipText()
      Returns the tip text for this property.
      protected List<String> buildCommand()
      Assembles the command to run.
      void defineOptions()
      Adds options to the internal list of options.
      String filterTipText()
      Returns the tip text for this property.
      boolean getAll()
      Returns whether to list all containers, not just running ones.
      protected adams.core.command.output.OutputFormatter getDefaultOutputFormatter()
      Returns the default output formatter.
      String getFilter()
      Returns the container filter.
      String getQuickInfo()
      Returns a quick info about the actor, which will be displayed in the GUI.
      boolean getShowOnlyIDs()
      Returns whether to list only the IDs or all the information.
      String globalInfo()
      Returns a string describing the object.
      void setAll​(boolean value)
      Sets whether to list all containers, not just running ones.
      void setFilter​(String value)
      Sets the container filter.
      void setShowOnlyIDs​(boolean value)
      Sets whether to list only the IDs or all the information.
      String showOnlyIDsTipText()
      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, 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, 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_All

        protected boolean m_All
        whether to list all containers.

      • m_Filter

        protected String m_Filter
        for filtering the containers.

      • m_ShowOnlyIDs

        protected boolean m_ShowOnlyIDs
        whether to only show the IDs.

    • Constructor Detail

      • ListContainers

        public ListContainers()

    • 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

      • getDefaultOutputFormatter

        protected adams.core.command.output.OutputFormatter getDefaultOutputFormatter()
        Returns the default output formatter.
        Overrides:
        getDefaultOutputFormatter in class adams.core.command.AbstractExternalCommand
        Returns:
        the default

      • setFilter

        public void setFilter​(String value)
        Sets the container filter.
        Parameters:
        value - the filter

      • getFilter

        public String getFilter()
        Returns the container filter.
        Returns:
        the filter

      • filterTipText

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

      • setAll

        public void setAll​(boolean value)
        Sets whether to list all containers, not just running ones.
        Parameters:
        value - true for all

      • getAll

        public boolean getAll()
        Returns whether to list all containers, not just running ones.
        Returns:
        true for all

      • allTipText

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

      • setShowOnlyIDs

        public void setShowOnlyIDs​(boolean value)
        Sets whether to list only the IDs or all the information.
        Parameters:
        value - true if only IDs

      • getShowOnlyIDs

        public boolean getShowOnlyIDs()
        Returns whether to list only the IDs or all the information.
        Returns:
        true if only IDs

      • showOnlyIDsTipText

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