Interface UpdateByIncludeRules2

    • Method Detail

      • getUpdater

        IncludeRuleUpdater getUpdater​(@NotNull
                                      VcsRoot root,
                                      @NotNull
                                      CheckoutRules checkoutRules,
                                      @NotNull
                                      java.lang.String toVersion,
                                      @NotNull
                                      java.io.File checkoutDirectory,
                                      @NotNull
                                      AgentRunningBuild build,
                                      boolean cleanCheckoutRequested)
                               throws VcsException
        Factory method that is used to create checkout-by-include rule implementation that will be called for each include rule from CheckoutRules. IncludeRuleUpdater.dispose() is called at the end of include rules processing. BuildProgressLogger can be used to add messages in the build log.
        Parameters:
        root - VCS root
        checkoutRules - checkout rules of entire checkout operation
        toVersion - version to update sources to
        checkoutDirectory - working directory where sources will be updated (root directory for the sources)
        build - agent running build. You can get logger by requesting build.getBuildLogger()
        cleanCheckoutRequested - true if clean checkout should be performed. Checkout directory itself will be already created by core. The flag also true if some include directory from checkout rules is missing comparing to the previous checkout.
        Returns:
        an instance of IncludeRuleUpdater that will be called for each include rule to perform checkout operation. if any error occurs preventing sources update
        Throws:
        VcsException - on VCS error
        Since:
        6.0