Class MSVSSCHECKOUT

  • All Implemented Interfaces:
    java.lang.Cloneable, MSVSSConstants

    public class MSVSSCHECKOUT
    extends MSVSS
    Performs CheckOut commands to Microsoft Visual SourceSafe.
    • Constructor Detail

      • MSVSSCHECKOUT

        public MSVSSCHECKOUT()
    • Method Detail

      • buildCmdLine

        protected Commandline buildCmdLine()
        Builds a command line to execute ss.
        Returns:
        The constructed commandline.
      • setLocalpath

        public void setLocalpath​(Path localPath)
        Override the project working directory.
        Parameters:
        localPath - The path on disk.
      • setRecursive

        public void setRecursive​(boolean recursive)
        Check-out files recursively. Defaults to false.
        Parameters:
        recursive - The boolean value for recursive.
      • setVersion

        public void setVersion​(java.lang.String version)
        Version to check-out.
        Parameters:
        version - The version to check-out.
      • setDate

        public void setDate​(java.lang.String date)
        Date to check-out.
        Parameters:
        date - The date to check-out.
      • setLabel

        public void setLabel​(java.lang.String label)
        Label to check-out.
        Parameters:
        label - The label to check-out.
      • setAutoresponse

        public void setAutoresponse​(java.lang.String response)
        Autoresponse behaviour. Valid options are Y and N.
        Parameters:
        response - The auto response value.
      • setFileTimeStamp

        public void setFileTimeStamp​(MSVSS.CurrentModUpdated timestamp)
        Date and time stamp given to the local copy. Defaults to current.
        Parameters:
        timestamp - The file time stamping behaviour.
      • setWritableFiles

        public void setWritableFiles​(MSVSS.WritableFiles files)
        Action taken when local files are writable. Defaults to fail.

        Due to ss.exe returning with an exit code of '100' for both errors and when a file has been skipped, failonerror is set to false when using the skip option.

        Parameters:
        files - The writable files behaviour
      • setGetLocalCopy

        public void setGetLocalCopy​(boolean get)
        Retrieve a local copy during a checkout. Defaults to true.
        Parameters:
        get - The get local copy behaviour