Class CheckOutScmResult

    • Field Detail

      • relativePathProjectDirectory

        protected String relativePathProjectDirectory
        The relative path of the directory of the checked out project in comparison to the checkout directory, or an empty String in case the checkout directory equals the project directory.

        With most SCMs, this is just an empty String, meaning that the checkout directory equals the project directory. But there are cases (e.g. ClearCase) where within the checkout directory, the directory structure of the SCM system is repeated. E.g. if you check out the project "my/project" to "/some/dir", the project sources are actually checked out to "my/project/some/dir". In this example, relativePathProjectDirectory would contain "my/project".

    • Constructor Detail

      • CheckOutScmResult

        public CheckOutScmResult​(String commandLine,
                                 String providerMessage,
                                 String commandOutput,
                                 boolean success)
      • CheckOutScmResult

        public CheckOutScmResult​(String commandLine,
                                 List<ScmFile> checkedOutFiles)
      • CheckOutScmResult

        public CheckOutScmResult​(String commandLine,
                                 String revision,
                                 List<ScmFile> checkedOutFiles)
      • CheckOutScmResult

        public CheckOutScmResult​(String commandLine,
                                 List<ScmFile> checkedOutFiles,
                                 String relativePathProjectDirectory)
      • CheckOutScmResult

        public CheckOutScmResult​(String commandLine,
                                 String revision,
                                 List<ScmFile> checkedOutFiles,
                                 String relativePathProjectDirectory)
    • Method Detail

      • getCheckedOutFiles

        public List<ScmFile> getCheckedOutFiles()
      • getRevision

        public String getRevision()
        Checked-out revision. SCM's that have no revision per repository (or branch) should store null here.
        Returns:
        the revision that was checked out.
        Since:
        1.8