Package jetbrains.buildServer.vcs
Interface IncludeRuleChangeCollector
-
public interface IncludeRuleChangeCollector
Handles change collecting portions corresponding to Include Rules. For each include rule a single call is made. This object could contain common data that should be shared between all calls (e.g. connection, caches, etc.). Don't forget to implementDisposable.dispose()
if those data require destruction.- Since:
- 4.5
- See Also:
CollectSingleStateChangesByIncludeRules
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.util.List<ModificationData>
collectChanges(IncludeRule includeRule)
Performs a portion of the change collecting work corresponding to the given include rule.void
dispose()
Called after the last include rule is processed bycollectChanges(IncludeRule)
.
-
-
-
Method Detail
-
collectChanges
@NotNull java.util.List<ModificationData> collectChanges(@NotNull IncludeRule includeRule) throws VcsException
Performs a portion of the change collecting work corresponding to the given include rule.- Parameters:
includeRule
- include rule without "to" part- Returns:
- the collection of change descriptors. Note, that all paths in the descriptors must be relative to the include rule's path.
- Throws:
VcsException
- if some problem occurred when collecting changes or changes cannot be collected because of invalid configuration.- See Also:
ModificationData
-
dispose
void dispose() throws VcsException
Called after the last include rule is processed bycollectChanges(IncludeRule)
. An implementation can clean resources (close connections, etc.) obtained during collector construction- Throws:
VcsException
- if an error occurred during disposing the collector
-
-