Package adams.docker.simpledocker

Class Info

  • All Implemented Interfaces:
    adams.core.CleanUpHandler, adams.core.command.AsyncCapableExternalCommand, adams.core.command.ExternalCommand, 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 Info
extends AbstractDockerCommand
    Outputs information about the docker environment ('docker info').
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected String m_FormatString
      for custom formatting.

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

    • 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 formatStringTipText()
      Returns the tip text for this property.
      String getFormatString()
      Returns the format string for the output.
      String getQuickInfo()
      Returns a quick info about the actor, which will be displayed in the GUI.
      String globalInfo()
      Returns a string describing the object.
      void setFormatString​(String value)
      Sets the format string for the output.

      • 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, 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_FormatString

        protected String m_FormatString
        for custom formatting.

    • Constructor Detail

      • Info

        public Info()

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

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

      • setFormatString

        public void setFormatString​(String value)
        Sets the format string for the output.
        Parameters:
        value - the format

      • getFormatString

        public String getFormatString()
        Returns the format string for the output.
        Returns:
        the format

      • formatStringTipText

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