Package adams.flow.transformer.git

Class Commit

  • 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 Commit
extends AbstractGitOperation
    Performs git commit.
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected adams.core.base.BaseText m_Message
      the commit message.

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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Class[] accepts()
      The type of data accepted as input.
      void defineOptions()
      Adds options to the internal list of options.
      protected boolean doCanExecute​(Object input, adams.core.MessageCollection errors)
      Checks whether the git operation can be executed.
      protected Object doExecute​(Object input, adams.core.MessageCollection errors)
      Executes the git operation.
      Class[] generates()
      The type of data that is being generated.
      adams.core.base.BaseText getMessage()
      Returns the commit message to use.
      String getQuickInfo()
      Returns a quick info about the object, which can be displayed in the GUI.
      String globalInfo()
      Returns a string describing the object.
      String messageTipText()
      Returns the tip text for this property.
      void setMessage​(adams.core.base.BaseText value)
      Sets the commit message to use.

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

        cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, toCommandLine, toString

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

        setLoggingLevel

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

        configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

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

        getLoggingLevel

    • Field Detail

      • m_Message

        protected adams.core.base.BaseText m_Message
        the commit message.

    • Constructor Detail

      • Commit

        public Commit()

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

      • setMessage

        public void setMessage​(adams.core.base.BaseText value)
        Sets the commit message to use.
        Parameters:
        value - the message

      • getMessage

        public adams.core.base.BaseText getMessage()
        Returns the commit message to use.
        Returns:
        the message

      • messageTipText

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

      • getQuickInfo

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

      • doCanExecute

        protected boolean doCanExecute​(Object input,
                               adams.core.MessageCollection errors)
        Checks whether the git operation can be executed.
        Specified by:
        doCanExecute in class AbstractGitOperation
        Parameters:
        input - the input data
        errors - for storing errors, can be null
        Returns:
        whether operation can be executed

      • doExecute

        protected Object doExecute​(Object input,
                           adams.core.MessageCollection errors)
        Executes the git operation.
        Specified by:
        doExecute in class AbstractGitOperation
        Parameters:
        input - the input data
        errors - for storing errors, can be null
        Returns:
        the result of the operation