jetbrains.buildServer.vcs
Interface CollectChangesByIncludeRules

All Superinterfaces:
CollectChangesPolicy, VcsExtension

public interface CollectChangesByIncludeRules
extends CollectChangesPolicy

This change collecting policy implies using IncludeRule for narrowing scope of monitored files. A more complex (but giving more control over performance) approach is presented by CollectChangesByCheckoutRules

Since:
4.5
See Also:
CollectChangesByCheckoutRules, CheckoutRules, IncludeRule, IncludeRuleChangeCollector

Method Summary
 IncludeRuleChangeCollector getChangeCollector(VcsRoot root, java.lang.String fromVersion, java.lang.String currentVersion)
          Returns an object that would handle calls for each include rule found in the checkout rules.
 

Method Detail

getChangeCollector

@NotNull
IncludeRuleChangeCollector getChangeCollector(@NotNull
                                                      VcsRoot root,
                                                      @NotNull
                                                      java.lang.String fromVersion,
                                                      @Nullable
                                                      java.lang.String currentVersion)
                                              throws VcsException
Returns an object that would handle calls for each include rule found in the checkout rules. This object could contain common data that should be shared between all calls (e.g. connection, caches, etc.). Check VcsSupportCore.isCurrentVersionExpensive() if you like to have null for currentVersion

Parameters:
root - VCS root
fromVersion - collect changes from this version.
currentVersion - collect changes to this version. If null collect changes to the current version of the VCS root.
Returns:
the object that would handle calls for each include rule
Throws:
VcsException - on error
See Also:
IncludeRule, IncludeRuleChangeCollector