Package jetbrains.vcs.api.services
Interface CollectChangesService
-
- All Superinterfaces:
VcsRemoteService
,VcsService
public interface CollectChangesService extends VcsService, VcsRemoteService
This service is responsible for actual changes collecting from the VCS- Since:
- 8.0
- Author:
- kir
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interface
CollectChangesService.ChangesConsumer
Callback interfacestatic class
CollectChangesService.RevisionMatchedByCheckoutRules
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
collectChanges(VcsSettings fromSettings, VcsRepositoryState fromState, VcsRepositoryState toState, CollectChangesService.ChangesConsumer consumer)
CollectChangesService.RevisionMatchedByCheckoutRules
getRevisionMatchedByCheckoutRules(VcsSettings vcsSettings, java.lang.String startRevision, java.lang.String startRevisionBranchName, java.util.Collection<java.lang.String> stopRevisions)
boolean
supportsCalculationOfRevisionMatchedByCheckoutRules(VcsSettings vcsSettings)
-
-
-
Method Detail
-
collectChanges
void collectChanges(@Nullable VcsSettings fromSettings, @NotNull VcsRepositoryState fromState, @NotNull VcsRepositoryState toState, @NotNull CollectChangesService.ChangesConsumer consumer) throws VcsException
- Parameters:
fromSettings
- Can contain repository in a slightly different state than current repository, for which this service is obtained. Basically, this is a repository for which previous repository state is obtained.fromState
- Previous repository state (collect changes from)toState
- New repository state (collect changes to)consumer
- Consumer object used to supply collected objects back to TeamCity- Throws:
VcsException
- if there is a problem collecting changes
-
supportsCalculationOfRevisionMatchedByCheckoutRules
boolean supportsCalculationOfRevisionMatchedByCheckoutRules(@NotNull VcsSettings vcsSettings)
- Parameters:
vcsSettings
- VCS Root settings specification to check- Returns:
- true if VCS plugin implements
RevisionMatchedByCheckoutRulesCalculator
-
getRevisionMatchedByCheckoutRules
@NotNull CollectChangesService.RevisionMatchedByCheckoutRules getRevisionMatchedByCheckoutRules(@NotNull VcsSettings vcsSettings, @NotNull java.lang.String startRevision, @NotNull java.lang.String startRevisionBranchName, @NotNull java.util.Collection<java.lang.String> stopRevisions) throws VcsException, java.lang.UnsupportedOperationException
- Throws:
java.lang.UnsupportedOperationException
- if VCS plugin does not support this operationVcsException
- Since:
- 2023.03
-
-