com.atlassian.bamboo.vcs.runtime

Interface IdentifyingExecutor<T extends IdentifyingExecutor>

All Known Subinterfaces:

CommitsIsolatingVcsChangeDetector, VcsBranchDetector, VcsBuildWarningsUpdater, VcsChangeDetector, VcsCommitCommenter, VcsPullRequestDetector

All Known Implementing Classes:

BitbucketCloudBranchDetector, BitbucketCloudChangeDetector, BitbucketCloudCommitCommenter, BitbucketCloudPullRequestDetector, BitbucketServerBranchDetector, BitbucketServerBuildWarningsUpdater, BitbucketServerChangeDetector, BitbucketServerPullRequestDetector, GitBranchDetector, GitChangeDetector, GitHubBranchDetector, GitHubChangeDetector, GitHubCommitCommenter, LegacyBranchDetector, LegacyChangeDetector, MercurialBranchDetector, MercurialChangeDetector, SvnBranchDetector, SvnChangeDetector

public interface IdentifyingExecutor<T extends IdentifyingExecutor>

Method Summary

Modifier and Type	Method and Description
ContextualVcsId	getVcsIdForExecutor(VcsRepositoryData vcsRepositoryData) Returned id has to fulfill the following: Given two VcsRepositoryData objects A and B, and executor e returning equal ContextualVcsId (in terms of equals()), for any operation foo() provided by the executor, the calls e::foo(A) and e::foo(B) should be equivalent.

Method Detail

getVcsIdForExecutor

@Nullable
ContextualVcsId getVcsIdForExecutor(@NotNull
                                              VcsRepositoryData vcsRepositoryData)

Returned id has to fulfill the following: Given two VcsRepositoryData objects A and B, and executor e returning equal ContextualVcsId (in terms of equals()), for any operation foo() provided by the executor, the calls e::foo(A) and e::foo(B) should be equivalent. To be more precise: given any time point t and any variable context v, calling a::foo(A) should yield the same results as calling e::foo(B). Given the above it follows that - calculation of the id should take into account global and plan variables. This means, that calling this method on the same object in different variable context can (possibly must) yield different results. - equal ids need not (and should not) guarantee equal call results over indefinite time. In particular, result of e:foo(A).equals(e::foo(A)) is allowed to be false, since 2 calls to e::foo(A) do not happen at the same time. Example: 2 git repositories with the same url and credentials are considered equal in context of VcsBranchDetector. If they also point to the same branch, they are considered equal in context of VcsChangeDetector

Returns:

the id of repository, can be null if no feasible identification algorithm exists