Package adams.flow.source.git

Class Clone

  • 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 Clone
extends AbstractGitOperation
    Performs git clone of the specified repo.
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected adams.core.io.PlaceholderDirectory m_Directory
      the directory to clone into.
      protected String m_Repository
      the repository to clone.

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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void defineOptions()
      Adds options to the internal list of options.
      String directoryTipText()
      Returns the tip text for this property.
      protected boolean doCanExecute​(adams.core.MessageCollection errors)
      Checks whether the git operation can be executed.
      protected Boolean doExecute​(adams.core.MessageCollection errors)
      Executes the git operation.
      Class[] generates()
      Returns the type of data of the output.
      adams.core.io.PlaceholderDirectory getDirectory()
      Returns the directory to clone into.
      String getQuickInfo()
      Returns a quick info about the object, which can be displayed in the GUI.
      String getRepository()
      Returns the URI of the repository to clone.
      String globalInfo()
      Returns a string describing the object.
      String repositoryTipText()
      Returns the tip text for this property.
      boolean requiresGitRepo()
      Whether a GitRepo instance is required.
      void setDirectory​(adams.core.io.PlaceholderDirectory value)
      Sets the directory to clone into.
      void setRepository​(String value)
      Sets the URI of the repository to clone.

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

        protected String m_Repository
        the repository to clone.

      • m_Directory

        protected adams.core.io.PlaceholderDirectory m_Directory
        the directory to clone into.

    • Constructor Detail

      • Clone

        public Clone()

    • 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

      • setRepository

        public void setRepository​(String value)
        Sets the URI of the repository to clone.
        Parameters:
        value - the URI

      • getRepository

        public String getRepository()
        Returns the URI of the repository to clone.
        Returns:
        the URI

      • repositoryTipText

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

      • setDirectory

        public void setDirectory​(adams.core.io.PlaceholderDirectory value)
        Sets the directory to clone into.
        Parameters:
        value - the directory

      • getDirectory

        public adams.core.io.PlaceholderDirectory getDirectory()
        Returns the directory to clone into.
        Returns:
        the directory

      • directoryTipText

        public String directoryTipText()
        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

      • requiresGitRepo

        public boolean requiresGitRepo()
        Whether a GitRepo instance is required.
        Overrides:
        requiresGitRepo in class AbstractGitOperation
        Returns:
        true if required

      • doCanExecute

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

      • doExecute

        protected Boolean doExecute​(adams.core.MessageCollection errors)
        Executes the git operation.
        Specified by:
        doExecute in class AbstractGitOperation
        Parameters:
        errors - for storing errors, can be null
        Returns:
        the operation output, null if failed