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 interface
static class	CollectChangesService.RevisionMatchedByCheckoutRules

Method Summary

Modifier and Type	Method	Description
void	collectChanges(VcsSettings fromSettings, VcsRepositoryState fromState, VcsRepositoryState toState, CollectChangesService.ChangesConsumer consumer)
CollectChangesService.RevisionMatchedByCheckoutRules	getRevisionMatchedByCheckoutRules(VcsSettings vcsSettings, String startRevision, String startRevisionBranchName, Collection<String> stopRevisions)	See RevisionMatchedByCheckoutRulesCalculator.
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
                                                                                       String startRevision,
                                                                                       @NotNull
                                                                                       String startRevisionBranchName,
                                                                                       @NotNull
                                                                                       Collection<String> stopRevisions)
                                                                                throws VcsException,
                                                                                       UnsupportedOperationException

See RevisionMatchedByCheckoutRulesCalculator.

Throws:

UnsupportedOperationException - if VCS plugin does not support this operation

VcsException

Since:

2023.03