Interface RuntimeVersionControl


  • public interface RuntimeVersionControl
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void checkout()
      Will checkout a fresh copy of the remote repository files.
      VersionControlSystem getApi​(java.util.Properties properties)
      Will return a fully configured low-level api should you wish to perform direct actions on the VCS.
      java.lang.String getImplementationName()
      Return the name of the version control system this implementation is built for.
      void setBootstrapProperties​(BootstrapProperties bootstrapProperties)
      Allow the Version Control System to configure itself through the Bootstrap Properties.
      void update()
      Updates the local repository with the remote repository changes.
    • Method Detail

      • getImplementationName

        java.lang.String getImplementationName()
        Return the name of the version control system this implementation is built for. An example might be "Subversion", "cvs", "git" etc.
        Returns:
        String
      • update

        void update()
             throws VcsException
        Updates the local repository with the remote repository changes.
        Throws:
        VcsException
      • checkout

        void checkout()
               throws VcsException
        Will checkout a fresh copy of the remote repository files.
        Throws:
        VcsException
      • setBootstrapProperties

        void setBootstrapProperties​(BootstrapProperties bootstrapProperties)
        Allow the Version Control System to configure itself through the Bootstrap Properties.
        Parameters:
        bootstrapProperties -
      • getApi

        VersionControlSystem getApi​(java.util.Properties properties)
                             throws VcsException
        Will return a fully configured low-level api should you wish to perform direct actions on the VCS.
        Parameters:
        properties - configuration for bootstrapping the VCS api
        Returns:
        a configured minimal VCS API
        Throws:
        VcsException
        Since:
        3.0.3